gaspersic/freeCodeCamp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update CONTRIBUTING for the use of the backend (#98)

Browse Source
This commit is contained in:
Stuart Taylor
2018-05-26 21:31:33 +01:00
committed by Mrugesh Mohapatra
parent 8f093c195b
commit d004171593
1 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
packages/learn/CONTRIBUTING.md
View File

@@ -4,14 +4,23 @@ Prerequisites | Minimum Version
|---|---|
node | ^8.11.x
[yarn](https://yarnpkg.com/en/) | ^1.3.0
[freeCodeCamp](https://github.com/freecodecamp/freecodecamp) | Running Locally
[freeCodeCamp/freeCodeCamp](https://github.com/freecodecamp/freecodecamp) currently holds the backend code for learn. The development process relies on this backend. You will see a message like below if you attemp to run `Learn` locally without it:
```sh
error UNHANDLED EXCEPTION
Error: connect ECONNREFUSED 127.0.0.1:3000
error Command failed with exit code 1.
```
1. Fork the repo
2. Clone locally
3. `yarn install`
4. `git checkout -b <your-branch-name>`
5. `cp sample.env .env`
6. `yarn develop`
6. `yarn develop` (Be sure you have `freeCodeCamp` running locally as well)
7. Make your changes
8. Make a PR
9. Bask in the glory of your accomplishments