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

fix(docs): Update troubleshooting and include docker commands (#36070)

Browse Source 
* fix(docs): Update troubleshooting and include docker commands

* fix: Streamline wording
This commit is contained in:
Oliver Eyton-Williams
2019-05-24 00:42:34 +02:00
committed by Manish Giri
parent cdd69f4c91
commit f8a4994257
1 changed files with 14 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/how-to-setup-freecodecamp-locally.md
View File

@@ -268,7 +268,7 @@ Congratulations 🎉🎉🎉! You now have a copy of freeCodeCamp's entire lear
## How to Sign in when working locally ## How to Sign in when working locally
Your local setup automatically populates a local user in the database. Clicking the `Sign In` button will automatically authenticate you into the local application. Your local setup automatically populates a local user in the database. Clicking the `Sign In` button will automatically authenticate you into the local application.
However, accessing the user portfolio page is a little tricky. In development, Gatsby takes over serving the client side pages and hence you will get a `404` page for the user portfolio when working locally. However, accessing the user portfolio page is a little tricky. In development, Gatsby takes over serving the client side pages and hence you will get a `404` page for the user portfolio when working locally.
Simply clicking the `Preview Custom 404 Page` button will forward you to the correct page. Simply clicking the `Preview Custom 404 Page` button will forward you to the correct page.
@@ -474,23 +474,29 @@ If you are stuck, and need help, let us know by asking in the ['Contributors' ca
There might be an error in the console of your browser or in Bash / Terminal / Command Line that will help identify the problem. Provide this error message in your problem description so others can more easily identify the issue and help you find a resolution. There might be an error in the console of your browser or in Bash / Terminal / Command Line that will help identify the problem. Provide this error message in your problem description so others can more easily identify the issue and help you find a resolution.
### Troubleshooting ### Troubleshooting
If the app launches but you are encountering errors with the UI itself, for example if fonts are not being loaded or if the code editor is not displaying properly, you may try the following troubleshooting steps at least once: If the app launches but you are encountering UI errors such as fonts not being loaded or the code editor not displaying properly, see the following depending on your local setup:
**Docker Build:**
```sh ```sh
# We use a mono repo and have multiple components (server, client, tools, plugins, etc.) # We use a mono repo and have multiple components (server, client, tools, plugins, etc.)
# Use this command to clean up all dependencies in all of the components # Use this command to clean up all dependencies in all of the components
npm run clean npm run docker:clean
# Reinstall npm packages # Reinstall npm packages
npm install npm run docker:install
# Bootstrap the project
npm run bootstrap
# Seed the database # Seed the database
npm run seed npm run docker:seed
# Restart the application # Restart the application
npm run docker:develop
```
**Local Build:**
```sh
npm run clean
npm ci
npm run seed
npm run develop npm run develop
``` ```