| 
									
										
										
										
											2018-10-08 22:26:06 +05:30
										 |  |  | <table> | 
					
						
							|  |  |  |     <tr> | 
					
						
							| 
									
										
										
										
											2018-10-12 01:13:03 +05:30
										 |  |  |         <!-- Do not translate this table --> | 
					
						
							| 
									
										
										
										
											2018-10-08 22:26:06 +05:30
										 |  |  |         <td> Read these guidelines in </td> | 
					
						
							|  |  |  |         <td><a href="/CONTRIBUTING.md"> English </a></td> | 
					
						
							| 
									
										
										
										
											2018-10-12 01:13:03 +05:30
										 |  |  |         <td><a href="/docs/arabic/README.md"> عربى </a></td> | 
					
						
							| 
									
										
										
										
											2018-10-08 22:26:06 +05:30
										 |  |  |         <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> | 
					
						
							| 
									
										
										
										
											2018-10-12 01:13:03 +05:30
										 |  |  |         <td><a href="/docs/spanish/README.md"> Español </a></td> | 
					
						
							| 
									
										
										
										
											2018-10-08 22:26:06 +05:30
										 |  |  |     </tr> | 
					
						
							|  |  |  | </table> | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-10-11 12:57:34 +05:30
										 |  |  | # Documentation Quick Reference
 | 
					
						
							| 
									
										
										
										
											2018-10-08 22:26:06 +05:30
										 |  |  | 
 | 
					
						
							|  |  |  | 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
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 1. How to work on Guide articles. | 
					
						
							| 
									
										
										
										
											2018-10-10 16:33:06 +05:30
										 |  |  | 2. How to work on Coding Challenges. | 
					
						
							| 
									
										
										
										
											2018-10-08 22:26:06 +05:30
										 |  |  | 3. How to setup freeCodeCamp locally. | 
					
						
							|  |  |  | 4. How to catch outgoing emails locally. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ## Style guides
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 1. Style guide for creating guide articles. | 
					
						
							| 
									
										
										
										
											2018-10-10 16:33:06 +05:30
										 |  |  | 2. Style guide for creating coding challenges. | 
					
						
							| 
									
										
										
										
											2018-10-08 22:26:06 +05:30
										 |  |  | 
 | 
					
						
							|  |  |  | ## Quick commands reference when working locally
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | A quick reference to the commands that you will need, when working locally. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | | command | description | | 
					
						
							|  |  |  | | ------- | ----------- | | 
					
						
							|  |  |  | | `npm run bootstrap` | 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 Apps | | 
					
						
							|  |  |  | | `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 | | 
					
						
							|  |  |  | | `npm run commit` | An interactive tool to help you build a good commit message | |