c911e77eed
* fix(docs): npm run commit has been removed * fix(docs): using `npm ci` makes more sense for bootstrapping Signed-off-by: Jonathan <theflametrooper@gmail.com>
51 lines
2.1 KiB
Markdown
51 lines
2.1 KiB
Markdown
<table>
|
|
<tr>
|
|
<!-- Do not translate this table -->
|
|
<td> Read these guidelines in </td>
|
|
<td><a href="/CONTRIBUTING.md"> English </a></td>
|
|
<td><a href="/docs/arabic/README.md"> عربي </a></td>
|
|
<td><a href="/docs/chinese/README.md"> 中文 </a></td>
|
|
<td><a href="/docs/russian/README.md"> русский </a></td>
|
|
<td><a href="/docs/portuguese/README.md"> Português </a></td>
|
|
<td><a href="/docs/spanish/README.md"> Español </a></td>
|
|
<td><a href="/docs/german/README.md"> Deutsch </a></td>
|
|
<td><a href="/docs/greek/README.md"> Ελληνικά </a></td>
|
|
</tr>
|
|
</table>
|
|
|
|
# Documentation Quick Reference
|
|
|
|
Hello 👋!
|
|
|
|
This directory contains all of the documentation on contributing to freeCodeCamp.org
|
|
|
|
## [If you are getting started, start by reading this first.](/CONTRIBUTING.md)
|
|
|
|
---
|
|
|
|
## Quick references articles
|
|
|
|
<a href="/docs/how-to-work-on-guide-articles.md">1. How to work on Guide articles.</a><br>
|
|
<a href="/docs/how-to-work-on-coding-challenges.md">2. How to work on Coding Challenges.</a><br>
|
|
<a href="/docs/how-to-setup-freecodecamp-locally.md">3. How to setup freeCodeCamp locally.</a><br>
|
|
<a href="/docs/how-to-catch-outgoing-emails-locally.md">4. How to catch outgoing emails locally.</a>
|
|
|
|
## Style guides
|
|
|
|
<a href="/docs/how-to-work-on-guide-articles.md">1. Style guide for creating guide articles.</a><br>
|
|
<a href="/docs/how-to-work-on-coding-challenges.md">2. Style guide for creating coding challenges.</a>
|
|
|
|
## Quick commands reference when working locally
|
|
|
|
A quick reference to the commands that you will need when working locally.
|
|
|
|
| command | description |
|
|
| ------- | ----------- |
|
|
| `npm ci` | Bootstraps the different services. |
|
|
| `npm run seed` | Parse all the challenge markdown files and inserts them into MongoDB. |
|
|
| `npm run develop` | Starts the freeCodeCamp API Server and Client Applications. |
|
|
| `npm test` | Run all JS tests in the system, including client, server, lint and challenge tests. |
|
|
| `npm run test:client` | Run the client test suite. |
|
|
| `npm run test:curriculum` | Run the curriculum test suite. |
|
|
| `npm run test:server` | Run the server test suite. |
|