freeCodeCamp/docs
Diego Siqueira 1be4450dbf Fixing small translation issues (#22101)
Fixing small translation issues in "Referência Rápida da Documentação" (README.md)
2019-08-10 22:23:10 -07:00
..
arabic [Order] [Arabic] Fixing chaotic order of table of languages (#36249) 2019-06-11 18:07:10 -07:00
chinese fix link styles in chinese contributing (#36223) 2019-06-27 23:22:25 -07:00
french First French translated file. (#32511) 2019-01-11 19:49:31 +05:30
german
greek Capitalized "русский" into "Русский" (#36255) 2019-06-11 18:22:57 -07:00
images docs: optimise images (#35240) 2019-02-16 12:04:16 +05:30
italian
korean Create README.korean.md (#36145) 2019-06-11 09:01:58 -05:00
macedonian Start with the Macedonian translation - Add README.md (#20760) 2018-11-14 08:05:50 -07:00
portuguese Fixing small translation issues (#22101) 2019-08-10 22:23:10 -07:00
romanian
russian [Russian] Correct links img (#31005) 2019-08-10 12:29:18 -07:00
spanish [Order] [Spanish] Fixing chaotic order of table of languages (#36250) 2019-06-11 18:27:48 -07:00
README.md fix(docs): npm run commit has been removed (#36451) 2019-07-23 18:41:49 +01:00
how-to-catch-outgoing-emails-locally.md docs(local): more energetic instructions (#24341) 2019-01-11 19:48:46 +05:30
how-to-open-a-pull-request.md docs: make scope and naming of Pull Requests clearer (#35272) 2019-03-05 21:38:26 +05:30
how-to-setup-freecodecamp-locally.md docs: add troubleshooting for network errors (#36485) 2019-07-25 16:44:37 +05:30
how-to-work-on-coding-challenges.md fix(docs) Corrected challenge template example (#35307) 2019-02-26 22:21:00 +03:00
how-to-work-on-guide-articles.md fix: typo (#36532) 2019-07-29 12:45:15 -07:00
style-guide-for-curriculum-challenges.md fix: added multiple note format rule (#36174) 2019-06-05 08:30:11 -05:00
style-guide-for-guide-articles.md Update style-guide-for-guide-articles.md (#36322) 2019-06-24 13:34:02 +07:00

README.md

Read these guidelines in English عربي 中文 русский Português Español Deutsch Ελληνικά

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.


Quick references articles

1. How to work on Guide articles.
2. How to work on Coding Challenges.
3. How to setup freeCodeCamp locally.
4. How to catch outgoing emails locally.

Style guides

1. Style guide for creating guide articles.
2. Style guide for creating coding challenges.

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.