Update CONTRIBUTING for the use of the backend (#98)
This commit is contained in:
committed by
Mrugesh Mohapatra
parent
8f093c195b
commit
d004171593
@@ -4,14 +4,23 @@ Prerequisites | Minimum Version
|
|||||||
|---|---|
|
|---|---|
|
||||||
node | ^8.11.x
|
node | ^8.11.x
|
||||||
[yarn](https://yarnpkg.com/en/) | ^1.3.0
|
[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
|
1. Fork the repo
|
||||||
2. Clone locally
|
2. Clone locally
|
||||||
3. `yarn install`
|
3. `yarn install`
|
||||||
4. `git checkout -b <your-branch-name>`
|
4. `git checkout -b <your-branch-name>`
|
||||||
5. `cp sample.env .env`
|
6. `yarn develop` (Be sure you have `freeCodeCamp` running locally as well)
|
||||||
6. `yarn develop`
|
|
||||||
7. Make your changes
|
7. Make your changes
|
||||||
8. Make a PR
|
8. Make a PR
|
||||||
9. Bask in the glory of your accomplishments
|
9. Bask in the glory of your accomplishments
|
||||||
|
Reference in New Issue
Block a user