https://amplify.nginx.com
+## Updating Instances (Maintenance) + +Config changes to our NGINX instances are maintained on GitHub, these should be deployed on each instance like so: + +1. SSH into the instance and enter sudo + +```console +sudo su +``` + +2. Get the latest config code. + +```console +cd /etc/nginx +git fetch --all --prune +git reset --hard origin/master +``` + +3. Test and reload the config [with Signals](https://docs.nginx.com/nginx/admin-guide/basic-functionality/runtime-control/#controlling-nginx). + +```console +nginx -t +nginx -s reload +``` + +# Work on API Instances + +1. Install build tools for node binaries (`node-gyp`) etc. + +```console +sudo apt install build-essential +``` + +## First Install + +Provisioning VMs with the Code + +1. Install Node LTS. + +2. Update `npm` and install PM2 and setup logrotate and startup on boot + + ```console + npm i -g npm + npm i -g pm2 + pm2 install pm2-logrotate + pm2 startup + ``` + +3. Clone freeCodeCamp, setup env and keys. + + ```console + git clone https://github.com/freeCodeCamp/freeCodeCamp.git + cd freeCodeCamp + git checkout production-current # or any other branch to be deployed + ``` + +4. Create the `.env` from the secure credentials storage. + +5. Create the `google-credentials.json` from the secure credentials storage. + +6. Install dependencies + + ```console + npm ci + ``` + +7. Build the server + + ```console + npm run ensure-env && npm run build:server + ``` + +8. Start Instances + + ```console + cd api-server + pm2 start production-start.js -i max --max-memory-restart 600M --name org + ``` + +## Logging and Monitoring + +```console +pm2 logs +``` + +```console +pm2 monit +``` + +## Updating Instances (Maintenance) + +Code changes need to be deployed to the API instances from time to time. It can be a rolling update or a manual update. The later is essential when changing dependencies or adding enviroment variables. + +> [!DANGER] The automated pipelines are not handling dependencies updates at the minute. We need to do a manual update before any deployment pipeline runs. + +### 1. Manual Updates - Used for updating dependencies, env variables. + +1. Stop all instances + +```console +pm2 stop all +``` + +2. Install dependencies + +```console +npm ci +``` + +3. Build the server + +```console +npm run ensure-env && npm run build:server +``` + +4. Start Instances + +```console +pm2 start all --update-env && pm2 logs +``` + +### 2. Rolling updates - Used for logical changes to code. + +```console +pm2 reload all --update-env && pm2 logs +``` + +> [!NOTE] We are handling rolling updates to code, logic, via pipelines. You should not need to run these commands. These are here for documentation. + +# Work on Client Instances + +1. Install build tools for node binaries (`node-gyp`) etc. + +```console +sudo apt install build-essential +``` + +## First Install + +Provisioning VMs with the Code + +1. Install Node LTS. + +2. Update `npm` and install PM2 and setup logrotate and startup on boot + + ```console + npm i -g npm + npm i -g pm2 + npm install -g serve + pm2 install pm2-logrotate + pm2 startup + ``` + +3. Clone client config, setup env and keys. + + ```console + git clone https://github.com/freeCodeCamp/client-config.git client + cd client + ``` + + ```console + git clone https://github.com/freeCodeCamp/client-config.git client + cd client + ``` + + Start placeholder instances for the web client, these will be updated with artifacts from the Azure pipline. + + > Todo: This setup needs to move to S3 or Azure Blob storage + > + > ```console + echo "serve -c ../../serve.json www -p 50505" >> client-start-primary.sh + chmod +x client-start-primary.sh + pm2 delete client-primary + pm2 start ./client-start-primary.sh --name client-primary + echo "serve -c ../../serve.json www -p 52525" >> client-start-secondary.sh + chmod +x client-start-secondary.sh + pm2 delete client-secondary + pm2 start ./client-start-secondary.sh --name client-secondary +``` + +## Logging and Monitoring + +```console +pm2 logs +``` + +```console +pm2 monit +``` + +## Updating Instances (Maintenance) + +Code changes need to be deployed to the API instances from time to time. It can be a rolling update or a manual update. The later is essential when changing dependencies or adding enviroment variables. + +> [!DANGER] The automated pipelines are not handling dependencies updates at the minute. We need to do a manual update before any deployment pipeline runs. + +### 1. Manual Updates - Used for updating dependencies, env variables. + +1. Stop all instances + + ```console + pm2 stop all + ``` + +2. Install or update dependencies + +3. Start Instances + + ```console + pm2 start all --update-env && pm2 logs + ``` + +### 2. Rolling updates - Used for logical changes to code. + +```console +pm2 reload all --update-env && pm2 logs +``` + +> [!NOTE] We are handling rolling updates to code, logic, via pipelines. You should not need to run these commands. These are here for documentation. diff --git a/docs/i18n/Afrikaans/how-to-catch-outgoing-emails-locally.md b/docs/i18n/Afrikaans/how-to-catch-outgoing-emails-locally.md new file mode 100644 index 0000000000..397ea3382a --- /dev/null +++ b/docs/i18n/Afrikaans/how-to-catch-outgoing-emails-locally.md @@ -0,0 +1,100 @@ +> **Note:** This is an **optional** step and is required only when working with email workflows + +## Introduction + +Some email workflows, like updating a user's email, requires the back-end api-server to send outgoing emails. An alternative to using an email service provider to send actual email messages, Mailhog is a developer tool for email testing that will catch the email messages sent by your freeCodeCamp instance. + +## Installing MailHog + +MailHog can be installed on macOS, Windows and Linux. + +- [Introduction](#introduction) +- [Installing MailHog](#installing-mailhog) + - [Installing MailHog on macOS](#installing-mailhog-on-macos) + - [Installing MailHog on Windows](#installing-mailhog-on-windows) + - [Installing MailHog on Linux](#installing-mailhog-on-linux) +- [Using MailHog](#using-mailhog) +- [Useful Links](#useful-links) + +### Installing MailHog on macOS + +Install MailHog on macOS with [Homebrew](https://brew.sh/): + +```bash +brew install mailhog +brew services start mailhog +``` + +The above commands will start a mailhog service in the background. + +When the installation completes, you can start [using MailHog](#using-mailhog). + +### Installing MailHog on Windows + +Download the latest version of MailHog from [MailHog's official repository](https://github.com/mailhog/MailHog/releases). Locate and click on the link for your Windows version (32 or 64 bit) and a .exe file will be downloaded to your computer. + +When the download completes, click to open the file. A Windows firewall notification may appear, requesting access permission for MailHog. A standard Windows command line prompt will open where MailHog will be running once firewall access is granted. + +Close MailHog by closing the command prompt window. To start MailHog again, click on the MailHog executable (.exe) file that was downloaded initially - it is not necessary to download a new MailHog installation file. + +Start [using MailHog](#using-mailhog). + +### Installing MailHog on Linux + +First, install [Go](https://golang.org). + +Run the following commands to install GO on Debian-based systems like Ubuntu and Linux Mint. + +```bash +sudo apt-get install golang +``` + +Run the following commands to install GO on RPM-based systems like CentOS, Fedora, Red Hat Linux, etc. + +```bash +sudo dnf install golang +``` + +Alternatively, run the following commands to install GO. + +```bash +sudo yum install golang +``` + +Now set the path for Go with the following commands. + +```bash +echo "export GOPATH=$HOME/go" >> ~/.profile +echo 'export PATH=$PATH:/usr/local/go/bin:$GOPATH/bin' >> ~/.profile +source ~/.profile +``` + +Finally, enter the commands below to install and run MailHog. + +```bash +go get github.com/mailhog/MailHog +sudo cp /home/$(whoami)/go/bin/MailHog /usr/local/bin/mailhog +mailhog +``` + +Start [using MailHog](#using-mailhog). + +## Using MailHog + +Open a new browser tab or window and navigate to [http://localhost:8025](http://localhost:8025) to open your MailHog inbox when the MailHog installation has completed and MailHog is running. The inbox will appear similar to the screen shot below. + + + +Emails sent by your freeCodeCamp installation will appear as below + + + +Two tabs that allow you to view either plain text or source content will be available when you open a given email. Ensure that the plain text tab is selected as below. + + + +All links in the email should be clickable and resolve to their URL. + +## Useful Links + +- Check out the [MailHog](https://github.com/mailhog/MailHog) repository for further information related to MailHog. Additional information is also available regarding custom MailHog configurations. diff --git a/docs/i18n/Afrikaans/how-to-help-with-video-challenges.md b/docs/i18n/Afrikaans/how-to-help-with-video-challenges.md new file mode 100644 index 0000000000..0724aaef02 --- /dev/null +++ b/docs/i18n/Afrikaans/how-to-help-with-video-challenges.md @@ -0,0 +1,199 @@ +# How to help with video challenges + +Video challenges are a new type of challenge in the freeCodeCamp curriculum. + +A video challenge is a small section of a full-length video course on a particular topic. A video challenge page embeds a YouTube video. Each challenge page has a single multiple-choice question related to the video. A user must answer the question correctly before moving on the the next video challenge in the course. + +The video challenge pages are created by members of the freeCodeCamp team. YouTube videos are also uploaded by members of the freeCodeCamp team. Many of the video challenges do not yet have questions associated with them. + +You can help by creating multiple choice questions related to video sections and adding the questions to the markdown files for the video challenges. + + +## Challenge Template + +Below is a template of what the challenge markdown files look like. + +````md +--- +id: Unique identifier (alphanumerical, MongoDB_id) +title: Challenge Title +challengeType: 11 +videoId: 'YouTube videoId for video challenge' +--- + +## Description + +` for a new line. HTML tags should be used sparingly, when questions cannot be expressed without them. + +### Question examples + +#### Examples without HTML + +````yml +question: + text: | + What does this JavaScript code log to the console? + ```js + console.log('hello world'); + ```` + + + Select an answer! + answers: + - | hello *world* + - | **hello** world + - | hello world solution: 3 +```` + +````yml +question: + text: | + What will print out after running this code: + ```py + width = 15 + height = 12.0 + print(height/3) + ```` + answers: + - | 39 + - | 4 + - | 4.0 + - | 5.0 + - | 5 solution: 3 +```` + +#### Example with HTML + +```yml +question: + text: | + What will print out after running this code: +
width = 15
height = 12.0
print(height/3)
+
+
+
+
+## Clone your fork from GitHub
+
+[Cloning](https://help.github.com/articles/cloning-a-repository/) is where you **download** a copy of a repository from a `remote` location that is either owned by you or by someone else. In your case, this remote location is your `fork` of freeCodeCamp's repository that should be available at `https://github.com/YOUR_USER_NAME/freeCodeCamp`.
+
+Run these commands on your local machine:
+
+1. Open a Terminal / Command Prompt / Shell in your projects directory
+
+ _i.e.: `/yourprojectsdirectory/`_
+
+2. Clone your fork of freeCodeCamp, replacing `YOUR_USER_NAME` with your GitHub Username
+
+ ```console
+ git clone --depth=1 https://github.com/YOUR_USER_NAME/freeCodeCamp.git
+ ```
+
+This will download the entire freeCodeCamp repository to your projects directory.
+
+Note: `--depth=1` creates a shallow clone of your fork, with only the most recent history/commit.
+
+## Set up syncing from parent
+
+Now that you have downloaded a copy of your fork, you will need to set up an `upstream` remote to the parent repository.
+
+[As mentioned earlier](#fork-the-repository-on-github), the main repository is referred `upstream` repository. Your fork referred to as the `origin` repository.
+
+You need a reference from your local clone to the `upstream` repository in addition to the `origin` repository. This is so that you can sync changes from the main repository without the requirement of forking and cloning repeatedly.
+
+1. Change directory to the new freeCodeCamp directory:
+
+ ```console
+ cd freeCodeCamp
+ ```
+
+2. Add a remote reference to the main freeCodeCamp repository:
+
+ ```console
+ git remote add upstream https://github.com/freeCodeCamp/freeCodeCamp.git
+ ```
+
+3. Ensure the configuration looks correct:
+
+ ```console
+ git remote -v
+ ```
+
+ The output should look something like below:
+
+ ```console
+ origin https://github.com/YOUR_USER_NAME/freeCodeCamp.git (fetch)
+ origin https://github.com/YOUR_USER_NAME/freeCodeCamp.git (push)
+ upstream https://github.com/freeCodeCamp/freeCodeCamp.git (fetch)
+ upstream https://github.com/freeCodeCamp/freeCodeCamp.git (push)
+ ```
+
+## Running freeCodeCamp locally
+
+Now that you have a local copy of freeCodeCamp, you can follow these instructions to run it locally. This will allow you to:
+
+- Preview edits to pages as they would appear on the learning platform.
+- Work on UI related issues and enhancements.
+- Debug and fix issues with the application servers and client apps.
+
+If you do run into issues, first perform a web search for your issue and see if it has already been answered. If you cannot find a solution, please search our [GitHub issues](https://github.com/freeCodeCamp/freeCodeCamp/issues) page for a solution and report the issue if it has not yet been reported.
+
+And as always, feel free to hop on to our [Contributors Chat room on Gitter](https://gitter.im/FreeCodeCamp/Contributors) or [our Discord server](https://discord.gg/6vJYm9V), for quick queries.
+
+> [!TIP] You may skip running freeCodeCamp locally if you are simply editing files. For instance, performing a `rebase`, or resolving `merge` conflicts.
+>
+> You can always return to this part of the instructions later. You should **only** skip this step if you do not need to run the apps on your machine.
+>
+> [Skip to making changes](#making-changes-locally).
+
+### Configuring dependencies
+
+#### Step 1: Set up the environment variable file
+
+The default API keys and environment variables are stored in the file `sample.env`. This file needs to be copied to a new file named `.env` that is accessed dynamically during the installation step.
+
+```console
+# Create a copy of the "sample.env" and name it ".env".
+# Populate it with the necessary API keys and secrets:
+
+# macOS / Linux
+cp sample.env .env
+
+# Windows
+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] Keep in mind if you want to use services like Auth0 or Algolia, you'll have to acquire your own API keys for those services and edit the entries accordingly in the `.env` file.
+
+#### Step 2: Install dependencies
+
+This step will install the dependencies required for the application to run:
+
+```console
+npm ci
+```
+
+#### Step 3: Start MongoDB and seed the database
+
+Before you can run the application locally, you will need to start the MongoDB service.
+
+> [!NOTE] Unless you have MongoDB running in a setup different than the default, the URL stored as the `MONGOHQ_URL` value in the `.env` file should work fine. If you are using a custom configuration, modify this value as needed.
+
+Start the MongoDB server in a separate terminal:
+
+- On macOS & Ubuntu:
+
+ ```console
+ mongod
+ ```
+
+- On Windows, you must specify the full path to the `mongod` binary
+
+ ```console
+ "C:\Program Files\MongoDB\Server\3.6\bin\mongod"
+ ```
+
+ 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/)
+
+Next, let's seed the database. In this step, we run the below command that fills the MongoDB server with some initial data sets that are required by services. These include a few schemas, among other things.
+
+```console
+npm run seed
+```
+
+#### Step 4: Start the freeCodeCamp client application and API server
+
+You can now start up the API server and the client applications.
+
+```console
+npm run develop
+```
+
+This single command will fire up all the services, including the API server and the client applications available for you to work on.
+
+> [!NOTE] Once ready, open a web browser and **visit + How to fork freeCodeCamp on GitHub (screenshot) +
+ ++
+
+
+
+
+
+## Making changes locally
+
+You can now make changes to files and commit your changes to your local clone of your fork.
+
+Follow these steps:
+
+1. Validate that you are on the `master` branch:
+
+ ```console
+ git status
+ ```
+
+ You should get an output like this:
+
+ ```console
+ On branch master
+ Your branch is up-to-date with 'origin/master'.
+
+ nothing to commit, working directory clean
+ ```
+
+ If you are not on master or your working directory is not clean, resolve any outstanding files/commits and checkout `master`:
+
+ ```console
+ git checkout master
+ ```
+
+2. Sync the latest changes from the freeCodeCamp upstream `master` branch to your local master branch:
+
+ > [!WARNING] If you have any outstanding pull request that you made from the `master` branch of your fork, you will lose them at the end of this step.
+ >
+ > You should ensure your pull request is merged by a moderator before performing this step. To avoid this scenario, you should **always** work on a branch other than the `master`.
+
+ This step **will sync the latest changes** from the main repository of freeCodeCamp. It is important that you rebase your branch on top of the latest `upstream/master` as often as possible to avoid conflicts later.
+
+ Update your local copy of the freeCodeCamp upstream repository:
+
+ ```console
+ git fetch upstream
+ ```
+
+ Hard reset your master branch with the freeCodeCamp master:
+
+ ```console
+ git reset --hard upstream/master
+ ```
+
+ Push your master branch to your origin to have a clean history on your fork on GitHub:
+
+ ```console
+ git push origin master --force
+ ```
+
+ You can validate your current master matches the upstream/master by performing a diff:
+
+ ```console
+ git diff upstream/master
+ ```
+
+ The resulting output should be empty.
+
+3. Create a fresh new branch:
+
+ Working on a separate branch for each issue helps you keep your local work copy clean. You should never work on the `master`. This will soil your copy of freeCodeCamp and you may have to start over with a fresh clone or fork.
+
+ Check that you are on `master` as explained previously, and branch off from there:
+
+ ```console
+ git checkout -b fix/update-guide-for-xyz
+ ```
+
+ Your branch name should start with a `fix/`, `feat/`, `docs/`, etc. Avoid using issue numbers in branches. Keep them short, meaningful and unique.
+
+ Some examples of good branch names are:
+
+ ```md
+ fix/update-challenges-for-react
+ fix/update-guide-for-html-css
+ fix/platform-bug-sign-in-issues
+ feat/add-guide-article-for-javascript
+ translate/add-spanish-basic-html
+ ```
+
+4. Edit pages and work on code in your favorite text editor.
+
+5. Once you are happy with the changes you should optionally run freeCodeCamp locally to preview the changes.
+
+6. Make sure you fix any errors and check the formatting of your changes.
+
+7. Check and confirm the files you are updating:
+
+ ```console
+ git status
+ ```
+
+ This should show a list of `unstaged` files that you have edited.
+
+ ```console
+ On branch feat/documentation
+ Your branch is up to date with 'upstream/feat/documentation'.
+
+ Changes not staged for commit:
+ (use "git add/rm + How to sign in when working locally (screenshot) +
+ ++
+
+
+
+
+
+### Issues with API, Login, Challenge Submissions, etc.
+
+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:**
+
+```console
+netstat -ab | grep "3000"
+
+tcp4 0 0 0.0.0.0:3000 DESKTOP LISTEN
+```
+
+**On Windows - From Elevated PowerShell:**
+
+```powershell
+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.
+
+The first time setup can take a while depending on your network bandwidth. Be patient, and if you are still stuck we recommed using GitPod instead of an offline setup.
+
+## Getting Help
+
+If you are stuck and need help, let us know by asking in the ['Contributors' category on our forum](https://forum.freecodecamp.org/c/contributors) or the [Contributors chat room](https://gitter.im/FreeCodeCamp/Contributors) on Gitter.
+
+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.
diff --git a/docs/i18n/Afrikaans/how-to-setup-wsl.md b/docs/i18n/Afrikaans/how-to-setup-wsl.md
new file mode 100644
index 0000000000..68bce6dde6
--- /dev/null
+++ b/docs/i18n/Afrikaans/how-to-setup-wsl.md
@@ -0,0 +1,129 @@
+# Set up freeCodeCamp on Windows Subsystem for Linux (WSL)
+
+> [!NOTE] Before you follow these instructions make sure your system meets the requirements
+>
+> **WSL 2**: Windows 10 64-bit (Version 2004, Build 19041 or higher) - available for all distributions including Windows 10 Home.
+>
+> **Docker Desktop for Windows**: See respective requirements for [Windows 10 Pro](https://docs.docker.com/docker-for-windows/install/#system-requirements) and [Windows 10 Home](https://docs.docker.com/docker-for-windows/install-windows-home/#system-requirements)
+
+This guide covers some common steps with the setup of WSL2. Once some of the common issues with WSL2 are addressed, you should be able to follow the our local setup guide to work with freeCodeCamp on Windows running a WSL distro like Ubuntu.
+
+## Enable WSL
+
+Follow the instructions on the [official documentation](https://docs.microsoft.com/en-us/windows/wsl/install-win10) to install WSL1 and followed by upgrading to WSL2.
+
+## Install Ubuntu
+
+1. We recommended using Ubuntu-18.04 or above with WSL2.
+
+ > [!NOTE]
+ >
+ > While you may use other non-debian based distros, they all come with their own gotchas and are beyond the scope of this guide.
+
+2. Update the dependencies for the OS
+
+ ```console
+ sudo apt update
+ sudo apt upgrade -y
+
+ # cleanup
+ sudo apt autoremove -y
+ ```
+
+## Set up Git
+
+Git comes pre-installed with Ubuntu 18.04, verify that your Git version with `git --version`.
+
+```output
+~
+❯ git --version
+git version 2.25.1
+```
+
+(Optional but recommended) You can now proceed to [setting up your ssh keys](https://help.github.com/articles/generating-an-ssh-key) with GitHub.
+
+## Installing a Code Editor
+
+We highly recommend installing [Visual Studio Code](https://code.visualstudio.com) on Windows 10. It has great support for WSL and automatically installs all the necessary extensions on your WSL distro.
+
+Essentially, you will edit and store your code on Ubuntu-18.04 with VS Code installed on Windows.
+
+## Installing Docker Desktop
+
+**Docker Desktop for Windows** allows you to install and run database and services like MongoDB, NGINX, etc. This is useful to avoid common pitfalls with installing MongoDB or other services directly on Windows or WSL2.
+
+Follow the instructuction on the [official documentation](https://docs.docker.com/docker-for-windows/install) and install Docker Desktop for your Windows distribution.
+
+There are some minimum hardware requirements for the best experience.
+
+## Configure Docker Desktop for WSL
+
+Once Docker Desktop is installed, [follow these instructions](https://docs.docker.com/docker-for-windows/wsl) and configure it to use the Ubuntu-18.04 installation as a backend.
+
+This makes it so that the containers run on WSL side instead of running on Windows. You will be able to access the services over `http://localhost` on both Windows and Ubuntu.
+
+## Install MongoDB from Docker Hub
+
+Once you have configured Docker Desktop to work with WSL2, follow these steps to start a MongoDB service:
+
+1. Launch a new Ubuntu-18.04 terminal
+
+2. Pull `MongoDB 3.6` from dockerhub
+
+ ```console
+ docker pull mongo:3
+ ```
+
+3. Start the MongoDB service at port `27017`, and configure it to run automatically on system restarts
+
+ ```console
+ docker run -it \
+ -v mongodata:/data/db \
+ -p 27017:27017 \
+ --name mongodb \
+ --restart unless-stopped \
+ -d mongo:3
+ ```
+
+4. You can now access the service from both Windows or Ubuntu at `mongodb://localhost:27017`.
+
+## Installing Node.js and npm
+
+We recommend you install the LTS release for Node.js with a node version manager - [nvm](https://github.com/nvm-sh/nvm#installing-and-updating).
+
+Once installed use these commands to install and use the Node.js version as needed
+
+```console
+nvm install --lts
+
+# OR
+# nvm install + How to clean git untracked files (screenshot) +
+ ++
+
+
+```{ext}
+Code displayed in the editor by default.
+
+This is a required section for the challenge.
+```
+
+
+
+### Before Test
+
+
+
+```{ext}
+Optional Test setup code.
+```
+
+
+
+### After Test
+
+
+
+```{ext}
+Optional Test tear down code.
+```
+
+
+
+` tags. For example, HTML tag names or CSS property names
+- The first instance of a keyword when it's being defined, or general keywords (i.e. "object" or "immutable") go in `` tags
+- References to code parts (i.e. function, method or variable names) should be wrapped in `` tags. See example below:
+- Use parseInt to convert the variable realNumber into an integer.
+- Multi-line code blocks **must be preceded by an empty line**. The next line must start with three backticks followed immediately by one of the [supported languages](https://prismjs.com/#supported-languages). To complete the code block, you must start a newline which only has three backticks and **another empty line**. **Note:** If you are going to use an example code in YAML, use `yaml` instead of `yml` for the language to the right of the backticks.
+
+See example below:
+
+````md
+The following is an example of code:
+
+```{language}
+
+[YOUR CODE HERE]
+
+````
+````
+
+- Additional information in the form of a note should be formatted `Note: Rest of note text...`
+- If multiple notes are needed, then list all of the notes in separate sentences using the format `Notes: First note text. Second note text.`.
+- Use double quotes where applicable
+
+## Writing tests
+
+Challenges should have the minimum number of tests necessary to verify that a camper understands a concept.
+
+Our goal is to communicate the single point that the challenge is trying to teach, and test that they have understood that point.
+
+Challenge tests can make use of the Node.js and Chai.js assertion libraries. Also, if needed, user-generated code can be accessed in the `code` variable.
+
+## Formatting seed code
+
+Here are specific formatting guidelines for the challenge seed code:
+
+- Use two spaces to indent
+- JavaScript statements end with a semicolon
+- Use double quotes where applicable
+- Comments made should have a space between the comment characters and the comment themselves
+
+ `// Fix this line`
+
+## Hints and Solutions
+
+Each challenge has a `Get a Hint` button, so a user can access any hints/solutions which have been created for the challenge. Curriculum hints/solutions topics are located on [our forum](https://forum.freecodecamp.org/c/guide) under the `Guide` category.
+
+If you find a problem with an existing challenge's hints/solutions topic, you can make suggestions in the [contributors category](https://forum.freecodecamp.org/c/contributors) on the forum. Moderators and users with trust level 3 will review the comments and decide whether or not to include the changes in the corresponding hint/solutions topic.
+
+### Adding new Challenge hints/solutions Topics
+
+Take the following steps when adding a new challenge hints/solutions related topic.
+
+1. Start by following the same steps for creating a new topic but review the next for creating the title.
+2. The title of the topic should start with `freeCodeCamp Challenge Guide: ` concatenated with the actual title of the curriculum challenge. For example, if the challenge is named "`Chunky Monkey`", the topic title would be "`freeCodeCamp Challenge Guide: Chunky Monkey`".
+3. `camperbot` should be the owner of these topics/posts, so you will need to request an admin to change the ownership of the main post to `camperbot`.
+4. Once the new topic is created, a forum topic id is created. It is located at the end of the forum topic URL. This id must be added to the frontmatter of the curriculum challenge file via the normal pull request process for the `Get a Hint` button to link to the topic.
+
+### Guidelines for content of hints and solutions topics
+
+When proposing a solution for a curriculum challenge related Guide topic, the full code must be added. This includes all the original seed code plus any changes needed to pass all the challenge tests. The following template should be used when creating new hints/solutions topics:
+
+````md
+# Challenge Name Goes Here
+
+---
+
+## Problem Explanation
+
+This summarizes what need to be done without just restating the challenge description and/or instructions. This is an optional section
+
+#### Relevant Links
+
+- [Link Text](link_url_goes_here)
+- [Link Text](link_url_goes_here)
+
+---
+
+## Hints
+
+### Hint 1
+
+Hint goes here
+
+### Hint 2
+
+Hint goes here
+
+---
+
+## Solutions
+
+Solution 1 (Click to Show/Hide)
+
+```js
+function myFunc() {
+ console.log('Hello World!');
+}
+````
+
+#### Code Explanation
+
+- Code explanation goes here
+- Code explanation goes here
+
+#### Relevant Links
+
+- [Link Text](link_url_goes_here)
+- [Link Text](link_url_goes_here)
+
+
+````
+
+## Testing Challenges
+
+Before you [create a pull request](how-to-open-a-pull-request.md) for your changes, you need to validate that the changes you have made do not inadvertently cause problems with the challenge.
+
+1. To test all challenges run the below command from the root directory
+
+````
+npm run test:curriculum
+```
+
+2. You can also test a block or a superblock of challenges with these commands
+
+```
+npm run test:curriculum --block='Basic HTML and HTML5'
+```
+
+```
+npm run test:curriculum --superblock=responsive-web-design
+```
+
+You are also able to test one challenge individually by performing the following steps:
+
+1. Switch to the `curriculum` directory:
+
+ ```
+ cd curriculum
+ ```
+
+2. Run the following for each challenge file for which you have changed:
+
+ ```
+ npm run test -- -g 'the full English title of the challenge'
+ ```
+
+Once you have verified that each challenge you've worked on passes the tests, [please create a pull request](https://github.com/freeCodeCamp/freeCodeCamp/blob/master/docs/how-to-open-a-pull-request.md).
+
+> [!TIP]
+> You can set the environment variable `LOCALE` in the `.env` to the language of the challenge(s) you need to test.
+>
+> The currently accepted values are `english` and `chinese`, with `english` being set by default.
+
+## Upcoming Challenge Template
+
+The challenge template in the process of being updated to a cleaner, less nested structure. This has not been completely finalized, but the following should close to the final structure:
+
+````mdx
+
+---
+id: Unique identifier (alphanumerical, MongoDB_id)
+title: 'Challenge Title'
+challengeType: Integer, defined in `client/utils/challengeTypes.js`
+videoUrl: 'url of video explanation'
+forumTopicId: 12345
+---
+
+import Script from './script.mdx';
+
+## --step-description--
+
+Description text, in markdown
+
+```html
+
+ example code
+
+```
+
+## --step-hints--
+
+![test-id-1]
+
+There will be an arbitrary number of triples of ids, instructions (in markdown) and code blocks.
+
+```js
+Code for test one
+```
+
+![test-id-2]
+
+More instructions in markdown syntax
+
+```js
+More code
+```
+
+## --step-seed--
+
+### --before-user-code--
+
+```lang
+Code evaluated before the user’s
+```
+
+### --after-user-code--
+
+```lang
+Code evaluated after the user’s, and just before the tests
+```
+
+### --seed-content--
+
+![index-html]
+
+```html
+Some html
+```
+
+```css
+Some css
+```
+
+```js
+Some js
+```
+
+![index-js]
+
+