diff --git a/docs/how-to-setup-freecodecamp-locally.md b/docs/how-to-setup-freecodecamp-locally.md index 414e2d89c5..217ae8fe6d 100644 --- a/docs/how-to-setup-freecodecamp-locally.md +++ b/docs/how-to-setup-freecodecamp-locally.md @@ -175,14 +175,24 @@ The default API keys and environment variables are stored in the file `sample.en ```console # Create a copy of the "sample.env" and name it ".env". # Populate it with the necessary API keys and secrets: +``` -# macOS / Linux + + +#### **macOS/Linux** + +```console cp sample.env .env +``` -# Windows +#### **Windows** + +```console copy sample.env .env ``` + + The keys in the `.env` file are _not_ required to be changed to run the app locally. You can leave the default values copied over from `sample.env` as-is. > [!TIP] @@ -205,19 +215,25 @@ Before you can run the application locally, you will need to start the MongoDB s Start the MongoDB server in a separate terminal: -- On macOS & Ubuntu: + - ```console - mongod - ``` +#### **macOS/Linux** + +```console +mongod +``` + +#### **Windows** - On Windows, you must specify the full path to the `mongod` binary - ```console - "C:\Program Files\MongoDB\Server\3.6\bin\mongod" - ``` +```console +"C:\Program Files\MongoDB\Server\3.6\bin\mongod" +``` - Make sure to replace `3.6` with the version you have installed + + +Make sure to replace `3.6` with the version you have installed > [!TIP] > You can avoid having to start MongoDB every time by installing it as a background service. You can [learn more about it in their documentation for your OS](https://docs.mongodb.com/manual/administration/install-community/) @@ -533,7 +549,9 @@ git clean -ifdX If you can't sign in, and instead you see a banner with an error message that it will be reported to freeCodeCamp, please double-check that your local port `3000` is not in use by a different program. -**On Linux / macOS / WSL on Windows - From Terminal:** + + +#### **macOS/Linux/WSL on Windows - From Terminal:** ```console netstat -a | grep "3000" @@ -541,7 +559,7 @@ netstat -a | grep "3000" tcp4 0 0 0.0.0.0:3000 DESKTOP LISTEN ``` -**On Windows - From Elevated PowerShell:** +#### **On Windows - From Elevated PowerShell:** ```powershell netstat -ab | Select-String "3000" @@ -549,6 +567,10 @@ netstat -ab | Select-String "3000" TCP 0.0.0.0:3000 DESKTOP LISTENING ``` + + +--- + ### Issues installing dependencies If you get errors while installing the dependencies, please make sure that you are not in a restricted network or your firewall settings do not prevent you from accessing resources. diff --git a/docs/index.html b/docs/index.html index d9bea94b08..2796ab3696 100644 --- a/docs/index.html +++ b/docs/index.html @@ -149,6 +149,14 @@ tag: 'remote-markdown-url' }, + tabs: { + persist: true, // default + sync: true, // default + theme: 'classic', // default + tabComments: true, // default + tabHeadings: true // default + }, + plugins: [ function (hook, vm) { hook.beforeEach(function (markdown) { @@ -216,8 +224,10 @@ ] }; - - + + + +