mirror of
https://github.com/freeCodeCamp/freeCodeCamp.git
synced 2026-01-31 09:03:41 -05:00
chore(i18n,docs): processed translations (#49957)
This commit is contained in:
@@ -1,45 +1,23 @@
|
||||
Follow these guidelines for setting up freeCodeCamp locally on your system. This is highly recommended if you want to contribute regularly.
|
||||
Follow these guidelines for setting up a development environment for freeCodeCamp. This is highly recommended if you want to contribute regularly.
|
||||
|
||||
Some of these contribution workflows – like fixing bugs in the codebase or curriculum – need you to run freeCodeCamp locally on your computer.
|
||||
## Choose between Gitpod or your own machine (local setup)
|
||||
|
||||
> [!TIP] If you are not interested in setting up freeCodeCamp locally, consider using Gitpod. We have automated the process of installing all the dependencies & tools you will need.
|
||||
>
|
||||
> Continue reading this guide to learn more about using GitPod.
|
||||
If you are looking to make a one-off contribution, you should use Gitpod to make changes. The Gitpod setup launches a ready-to-code environment in a few minutes in your web browser. For contributing long-term, we recommend you setup freeCodeCamp on your local machine.
|
||||
|
||||
## Fork the repository on GitHub
|
||||
Here are some pros and cons which should help you decide which option is best for you:
|
||||
|
||||
[Forking](https://help.github.com/articles/about-forks/) is a step where you get your own copy of freeCodeCamp's main repository (a.k.a _repo_) on GitHub.
|
||||
| Gitpod | Your own machine (local setup) |
|
||||
| ----------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| No minimum hardware requirements | Specific and minimum requirements |
|
||||
| No need to install any software | Additional software required |
|
||||
| Always up to date copy of repository | Need to maintain a local copy of the repository |
|
||||
| Slower and can take a few minutes to launch | Faster and can be launched in seconds |
|
||||
| Need an internet connection to work | Minimal internet connection required (once setup) |
|
||||
| Some tasks like compilation and tests can take longer to complete | Faster completion of tasks (depending on your machine's capabilities) |
|
||||
|
||||
This is essential, as it allows you to work on your own copy of freeCodeCamp on GitHub, or to download (clone) your repository to work on locally. Later, you will be able to request changes to be pulled into the main repository from your fork via a pull request (PR).
|
||||
> [!ATTENTION] **Note:** If you are using Windows 10 or 11, you will need to use WSL2. You can follow [this guide](how-to-setup-wsl.md) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.
|
||||
|
||||
> [!TIP] The main repository at `https://github.com/freeCodeCamp/freeCodeCamp` is often referred to as the `upstream` repository.
|
||||
>
|
||||
> Your fork at `https://github.com/YOUR_USER_NAME/freeCodeCamp` is often referred to as the `origin` repository. `YOUR_USER_NAME` would be replaced with your GitHub username.
|
||||
|
||||
**Follow these steps to fork the `https://github.com/freeCodeCamp/freeCodeCamp` repository:**
|
||||
|
||||
1. Go to the freeCodeCamp repository on GitHub: <https://github.com/freeCodeCamp/freeCodeCamp>
|
||||
|
||||
2. Click the "Fork" Button in the upper right-hand corner of the interface ([More Details Here](https://help.github.com/articles/fork-a-repo/))
|
||||
|
||||
3. After the repository has been forked, you will be taken to your copy of the freeCodeCamp repository at `https://github.com/YOUR_USER_NAME/freeCodeCamp` (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
How to fork freeCodeCamp on GitHub (screenshot)
|
||||
</summary>
|
||||
|
||||
<br>
|
||||
<img src="https://raw.githubusercontent.com/freeCodeCamp/freeCodeCamp/main/docs/images/github/how-to-fork-freeCodeCamp.gif" alt="How to fork freeCodeCamp on GitHub" />
|
||||
</details>
|
||||
|
||||
## Use a Local Machine or GitPod
|
||||
|
||||
Once you have forked the repository, you can either use your own local machine or a GitPod-based workspace to work on the codebase.
|
||||
|
||||
For contributing long-term, we recommend you setup freeCodeCamp on your local machine.
|
||||
|
||||
### How to prepare a GitPod workspace
|
||||
### How to prepare a Gitpod workspace
|
||||
|
||||
We have automated the process of installing all the dependencies & tools you will need. With GitPod you get a free ready-to-code environment in a few minutes, and is useful if you do not have access to computer or want to make one-time changes.
|
||||
|
||||
@@ -62,13 +40,16 @@ That's it, you can now skip to the 'syncing up from parent' section after you ha
|
||||
|
||||
### How to prepare your local machine
|
||||
|
||||
Here is a minimum system requirement for running freeCodeCamp locally:
|
||||
|
||||
- 8 GB RAM
|
||||
- Relatively fast CPU (4+ cores)
|
||||
- Windows 10 or 11 (with WSL), macOS, or Linux
|
||||
|
||||
Start by installing the prerequisite software for your operating system.
|
||||
|
||||
We primarily support development on Linux and Unix-based systems. Our staff and community contributors regularly work with the codebase using tools installed on Ubuntu and macOS.
|
||||
We primarily support development on Linux and Unix-based systems like Ubuntu and macOS. You can develop on Windows 10 or 11 with WSL2 only. You can follow [this guide](how-to-setup-wsl.md) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.
|
||||
|
||||
We also support Windows 10 and 11 via WSL2, which you can prepare by [reading this guide](how-to-setup-wsl.md).
|
||||
|
||||
Some community members also develop on Windows natively with Git for Windows (Git Bash), and other tools installed on Windows. We do not have official support for such a setup at this time, we recommend using WSL2 instead.
|
||||
|
||||
#### Prerequisites:
|
||||
|
||||
@@ -107,6 +88,33 @@ Once you have the prerequisites installed, you need to prepare your development
|
||||
|
||||
> [!TIP] Please do not ignore any linting errors. They are meant to **help** you and to ensure a clean and simple codebase.
|
||||
|
||||
## Fork the repository on GitHub
|
||||
|
||||
[Forking](https://help.github.com/articles/about-forks/) is a step where you get your own copy of freeCodeCamp's main repository (a.k.a _repo_) on GitHub.
|
||||
|
||||
This is essential, as it allows you to work on your own copy of freeCodeCamp on GitHub, or to download (clone) your repository to work on locally. Later, you will be able to request changes to be pulled into the main repository from your fork via a pull request (PR).
|
||||
|
||||
> [!TIP] The main repository at `https://github.com/freeCodeCamp/freeCodeCamp` is often referred to as the `upstream` repository.
|
||||
>
|
||||
> Your fork at `https://github.com/YOUR_USER_NAME/freeCodeCamp` is often referred to as the `origin` repository. `YOUR_USER_NAME` would be replaced with your GitHub username.
|
||||
|
||||
**Follow these steps to fork the `https://github.com/freeCodeCamp/freeCodeCamp` repository:**
|
||||
|
||||
1. Go to the freeCodeCamp repository on GitHub: <https://github.com/freeCodeCamp/freeCodeCamp>
|
||||
|
||||
2. Click the "Fork" Button in the upper right-hand corner of the interface ([More Details Here](https://help.github.com/articles/fork-a-repo/))
|
||||
|
||||
3. After the repository has been forked, you will be taken to your copy of the freeCodeCamp repository at `https://github.com/YOUR_USER_NAME/freeCodeCamp` (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
How to fork freeCodeCamp on GitHub (screenshot)
|
||||
</summary>
|
||||
|
||||
<br>
|
||||
<img src="https://raw.githubusercontent.com/freeCodeCamp/freeCodeCamp/main/docs/images/github/how-to-fork-freeCodeCamp.gif" alt="How to fork freeCodeCamp on GitHub" />
|
||||
</details>
|
||||
|
||||
## 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`. (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
|
||||
@@ -1,45 +1,23 @@
|
||||
Follow these guidelines for setting up freeCodeCamp locally on your system. This is highly recommended if you want to contribute regularly.
|
||||
Follow these guidelines for setting up a development environment for freeCodeCamp. This is highly recommended if you want to contribute regularly.
|
||||
|
||||
Some of these contribution workflows – like fixing bugs in the codebase or curriculum – need you to run freeCodeCamp locally on your computer.
|
||||
## Choose between Gitpod or your own machine (local setup)
|
||||
|
||||
> [!TIP] If you are not interested in setting up freeCodeCamp locally, consider using Gitpod. We have automated the process of installing all the dependencies & tools you will need.
|
||||
>
|
||||
> Continue reading this guide to learn more about using GitPod.
|
||||
If you are looking to make a one-off contribution, you should use Gitpod to make changes. The Gitpod setup launches a ready-to-code environment in a few minutes in your web browser. For contributing long-term, we recommend you setup freeCodeCamp on your local machine.
|
||||
|
||||
## Fork the repository on GitHub
|
||||
Here are some pros and cons which should help you decide which option is best for you:
|
||||
|
||||
[Forking](https://help.github.com/articles/about-forks/) is a step where you get your own copy of freeCodeCamp's main repository (a.k.a _repo_) on GitHub.
|
||||
| Gitpod | Your own machine (local setup) |
|
||||
| ----------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| No minimum hardware requirements | Specific and minimum requirements |
|
||||
| No need to install any software | Additional software required |
|
||||
| Always up to date copy of repository | Need to maintain a local copy of the repository |
|
||||
| Slower and can take a few minutes to launch | Faster and can be launched in seconds |
|
||||
| Need an internet connection to work | Minimal internet connection required (once setup) |
|
||||
| Some tasks like compilation and tests can take longer to complete | Faster completion of tasks (depending on your machine's capabilities) |
|
||||
|
||||
This is essential, as it allows you to work on your own copy of freeCodeCamp on GitHub, or to download (clone) your repository to work on locally. Later, you will be able to request changes to be pulled into the main repository from your fork via a pull request (PR).
|
||||
> [!ATTENTION] **Note:** If you are using Windows 10 or 11, you will need to use WSL2. You can follow [this guide](how-to-setup-wsl.md) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.
|
||||
|
||||
> [!TIP] The main repository at `https://github.com/freeCodeCamp/freeCodeCamp` is often referred to as the `upstream` repository.
|
||||
>
|
||||
> Your fork at `https://github.com/YOUR_USER_NAME/freeCodeCamp` is often referred to as the `origin` repository. `YOUR_USER_NAME` would be replaced with your GitHub username.
|
||||
|
||||
**Follow these steps to fork the `https://github.com/freeCodeCamp/freeCodeCamp` repository:**
|
||||
|
||||
1. Go to the freeCodeCamp repository on GitHub: <https://github.com/freeCodeCamp/freeCodeCamp>
|
||||
|
||||
2. Click the "Fork" Button in the upper right-hand corner of the interface ([More Details Here](https://help.github.com/articles/fork-a-repo/))
|
||||
|
||||
3. After the repository has been forked, you will be taken to your copy of the freeCodeCamp repository at `https://github.com/YOUR_USER_NAME/freeCodeCamp` (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
How to fork freeCodeCamp on GitHub (screenshot)
|
||||
</summary>
|
||||
|
||||
<br>
|
||||
<img src="https://raw.githubusercontent.com/freeCodeCamp/freeCodeCamp/main/docs/images/github/how-to-fork-freeCodeCamp.gif" alt="How to fork freeCodeCamp on GitHub" />
|
||||
</details>
|
||||
|
||||
## Use a Local Machine or GitPod
|
||||
|
||||
Once you have forked the repository, you can either use your own local machine or a GitPod-based workspace to work on the codebase.
|
||||
|
||||
For contributing long-term, we recommend you setup freeCodeCamp on your local machine.
|
||||
|
||||
### How to prepare a GitPod workspace
|
||||
### How to prepare a Gitpod workspace
|
||||
|
||||
We have automated the process of installing all the dependencies & tools you will need. With GitPod you get a free ready-to-code environment in a few minutes, and is useful if you do not have access to computer or want to make one-time changes.
|
||||
|
||||
@@ -62,13 +40,16 @@ That's it, you can now skip to the 'syncing up from parent' section after you ha
|
||||
|
||||
### How to prepare your local machine
|
||||
|
||||
Here is a minimum system requirement for running freeCodeCamp locally:
|
||||
|
||||
- 8 GB RAM
|
||||
- Relatively fast CPU (4+ cores)
|
||||
- Windows 10 or 11 (with WSL), macOS, or Linux
|
||||
|
||||
Start by installing the prerequisite software for your operating system.
|
||||
|
||||
We primarily support development on Linux and Unix-based systems. Our staff and community contributors regularly work with the codebase using tools installed on Ubuntu and macOS.
|
||||
We primarily support development on Linux and Unix-based systems like Ubuntu and macOS. You can develop on Windows 10 or 11 with WSL2 only. You can follow [this guide](how-to-setup-wsl.md) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.
|
||||
|
||||
We also support Windows 10 and 11 via WSL2, which you can prepare by [reading this guide](how-to-setup-wsl.md).
|
||||
|
||||
Some community members also develop on Windows natively with Git for Windows (Git Bash), and other tools installed on Windows. We do not have official support for such a setup at this time, we recommend using WSL2 instead.
|
||||
|
||||
#### Prerequisites:
|
||||
|
||||
@@ -107,6 +88,33 @@ Once you have the prerequisites installed, you need to prepare your development
|
||||
|
||||
> [!TIP] Please do not ignore any linting errors. They are meant to **help** you and to ensure a clean and simple codebase.
|
||||
|
||||
## Fork the repository on GitHub
|
||||
|
||||
[Forking](https://help.github.com/articles/about-forks/) is a step where you get your own copy of freeCodeCamp's main repository (a.k.a _repo_) on GitHub.
|
||||
|
||||
This is essential, as it allows you to work on your own copy of freeCodeCamp on GitHub, or to download (clone) your repository to work on locally. Later, you will be able to request changes to be pulled into the main repository from your fork via a pull request (PR).
|
||||
|
||||
> [!TIP] The main repository at `https://github.com/freeCodeCamp/freeCodeCamp` is often referred to as the `upstream` repository.
|
||||
>
|
||||
> Your fork at `https://github.com/YOUR_USER_NAME/freeCodeCamp` is often referred to as the `origin` repository. `YOUR_USER_NAME` would be replaced with your GitHub username.
|
||||
|
||||
**Follow these steps to fork the `https://github.com/freeCodeCamp/freeCodeCamp` repository:**
|
||||
|
||||
1. Go to the freeCodeCamp repository on GitHub: <https://github.com/freeCodeCamp/freeCodeCamp>
|
||||
|
||||
2. Click the "Fork" Button in the upper right-hand corner of the interface ([More Details Here](https://help.github.com/articles/fork-a-repo/))
|
||||
|
||||
3. After the repository has been forked, you will be taken to your copy of the freeCodeCamp repository at `https://github.com/YOUR_USER_NAME/freeCodeCamp` (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
How to fork freeCodeCamp on GitHub (screenshot)
|
||||
</summary>
|
||||
|
||||
<br>
|
||||
<img src="https://raw.githubusercontent.com/freeCodeCamp/freeCodeCamp/main/docs/images/github/how-to-fork-freeCodeCamp.gif" alt="How to fork freeCodeCamp on GitHub" />
|
||||
</details>
|
||||
|
||||
## 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`. (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
|
||||
@@ -1,45 +1,23 @@
|
||||
Sigue estas instrucciones para configurar freeCodeCamp localmente en tu sistema. Esto es altamente recomendable si desea contribuir regularmente.
|
||||
Follow these guidelines for setting up a development environment for freeCodeCamp. Esto es altamente recomendable si desea contribuir regularmente.
|
||||
|
||||
Algunos de estos flujos de trabajo de contribución – como corregir errores en el código base o currículum – necesitan que ejecutes freeCodeCamp localmente en tu ordenador.
|
||||
## Choose between Gitpod or your own machine (local setup)
|
||||
|
||||
> [!TIP] If you are not interested in setting up freeCodeCamp locally, consider using Gitpod. We have automated the process of installing all the dependencies & tools you will need.
|
||||
>
|
||||
> Continue reading this guide to learn more about using GitPod.
|
||||
If you are looking to make a one-off contribution, you should use Gitpod to make changes. The Gitpod setup launches a ready-to-code environment in a few minutes in your web browser. For contributing long-term, we recommend you setup freeCodeCamp on your local machine.
|
||||
|
||||
## Bifurcar el repositorio en GitHub
|
||||
Here are some pros and cons which should help you decide which option is best for you:
|
||||
|
||||
[Forking](https://help.github.com/articles/about-forks/) is a step where you get your own copy of freeCodeCamp's main repository (a.k.a _repo_) on GitHub.
|
||||
| Gitpod | Your own machine (local setup) |
|
||||
| ----------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| No minimum hardware requirements | Specific and minimum requirements |
|
||||
| No need to install any software | Additional software required |
|
||||
| Always up to date copy of repository | Need to maintain a local copy of the repository |
|
||||
| Slower and can take a few minutes to launch | Faster and can be launched in seconds |
|
||||
| Need an internet connection to work | Minimal internet connection required (once setup) |
|
||||
| Some tasks like compilation and tests can take longer to complete | Faster completion of tasks (depending on your machine's capabilities) |
|
||||
|
||||
This is essential, as it allows you to work on your own copy of freeCodeCamp on GitHub, or to download (clone) your repository to work on locally. Later, you will be able to request changes to be pulled into the main repository from your fork via a pull request (PR).
|
||||
> [!ATTENTION] **Note:** If you are using Windows 10 or 11, you will need to use WSL2. You can follow [this guide](how-to-setup-wsl.md) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.
|
||||
|
||||
> [!TIP] The main repository at `https://github.com/freeCodeCamp/freeCodeCamp` is often referred to as the `upstream` repository.
|
||||
>
|
||||
> Your fork at `https://github.com/YOUR_USER_NAME/freeCodeCamp` is often referred to as the `origin` repository. `YOUR_USER_NAME` would be replaced with your GitHub username.
|
||||
|
||||
**Follow these steps to fork the `https://github.com/freeCodeCamp/freeCodeCamp` repository:**
|
||||
|
||||
1. Go to the freeCodeCamp repository on GitHub: <https://github.com/freeCodeCamp/freeCodeCamp>
|
||||
|
||||
2. Click the "Fork" Button in the upper right-hand corner of the interface ([More Details Here](https://help.github.com/articles/fork-a-repo/))
|
||||
|
||||
3. After the repository has been forked, you will be taken to your copy of the freeCodeCamp repository at `https://github.com/YOUR_USER_NAME/freeCodeCamp` (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
How to fork freeCodeCamp on GitHub (screenshot)
|
||||
</summary>
|
||||
|
||||
<br>
|
||||
<img src="https://raw.githubusercontent.com/freeCodeCamp/freeCodeCamp/main/docs/images/github/how-to-fork-freeCodeCamp.gif" alt="How to fork freeCodeCamp on GitHub" />
|
||||
</details>
|
||||
|
||||
## Use a Local Machine or GitPod
|
||||
|
||||
Once you have forked the repository, you can either use your own local machine or a GitPod-based workspace to work on the codebase.
|
||||
|
||||
For contributing long-term, we recommend you setup freeCodeCamp on your local machine.
|
||||
|
||||
### How to prepare a GitPod workspace
|
||||
### How to prepare a Gitpod workspace
|
||||
|
||||
We have automated the process of installing all the dependencies & tools you will need. With GitPod you get a free ready-to-code environment in a few minutes, and is useful if you do not have access to computer or want to make one-time changes.
|
||||
|
||||
@@ -62,21 +40,24 @@ That's it, you can now skip to the 'syncing up from parent' section after you ha
|
||||
|
||||
### How to prepare your local machine
|
||||
|
||||
Here is a minimum system requirement for running freeCodeCamp locally:
|
||||
|
||||
- 8 GB RAM
|
||||
- Relatively fast CPU (4+ cores)
|
||||
- Windows 10 or 11 (with WSL), macOS, or Linux
|
||||
|
||||
Start by installing the prerequisite software for your operating system.
|
||||
|
||||
We primarily support development on Linux and Unix-based systems. Our staff and community contributors regularly work with the codebase using tools installed on Ubuntu and macOS.
|
||||
We primarily support development on Linux and Unix-based systems like Ubuntu and macOS. You can develop on Windows 10 or 11 with WSL2 only. You can follow [this guide](how-to-setup-wsl.md) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.
|
||||
|
||||
We also support Windows 10 and 11 via WSL2, which you can prepare by [reading this guide](how-to-setup-wsl.md).
|
||||
|
||||
Some community members also develop on Windows natively with Git for Windows (Git Bash), and other tools installed on Windows. We do not have official support for such a setup at this time, we recommend using WSL2 instead.
|
||||
|
||||
#### Pre-requisitos:
|
||||
|
||||
| Prerrequisito | Versión | Notas |
|
||||
| ----------------------------------------------------------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------- |
|
||||
| [Node.js](http://nodejs.org) | `18.x` | Utilizamos la versión "Activos LTS", ejemplo[ LTS Schedule](https://nodejs.org/en/about/releases/). |
|
||||
| [pnpm](https://pnpm.io/installation) | `8.x` | - |
|
||||
| [Servidor de la comunidad MongoDB](https://docs.mongodb.com/manual/administration/install-community/) | `4.2.x` | - |
|
||||
| Prerequisite | Version | Notes |
|
||||
| --------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------- |
|
||||
| [Node.js](http://nodejs.org) | `18.x` | We use the "Active LTS" version, See [LTS Schedule](https://nodejs.org/en/about/releases/). |
|
||||
| [pnpm](https://pnpm.io/installation) | `8.x` | - |
|
||||
| [MongoDB Community Server](https://docs.mongodb.com/manual/administration/install-community/) | `4.2.x` | - |
|
||||
|
||||
> [!ATTENTION] If you have a different version, please install the recommended version. We can only support installation issues for recommended versions. See [troubleshooting](#troubleshooting) for details.
|
||||
|
||||
@@ -107,6 +88,33 @@ Once you have the prerequisites installed, you need to prepare your development
|
||||
|
||||
> [!TIP] Please do not ignore any linting errors. They are meant to **help** you and to ensure a clean and simple codebase.
|
||||
|
||||
## Fork the repository on GitHub
|
||||
|
||||
[Forking](https://help.github.com/articles/about-forks/) is a step where you get your own copy of freeCodeCamp's main repository (a.k.a _repo_) on GitHub.
|
||||
|
||||
This is essential, as it allows you to work on your own copy of freeCodeCamp on GitHub, or to download (clone) your repository to work on locally. Later, you will be able to request changes to be pulled into the main repository from your fork via a pull request (PR).
|
||||
|
||||
> [!TIP] The main repository at `https://github.com/freeCodeCamp/freeCodeCamp` is often referred to as the `upstream` repository.
|
||||
>
|
||||
> Your fork at `https://github.com/YOUR_USER_NAME/freeCodeCamp` is often referred to as the `origin` repository. `YOUR_USER_NAME` would be replaced with your GitHub username.
|
||||
|
||||
**Follow these steps to fork the `https://github.com/freeCodeCamp/freeCodeCamp` repository:**
|
||||
|
||||
1. Go to the freeCodeCamp repository on GitHub: <https://github.com/freeCodeCamp/freeCodeCamp>
|
||||
|
||||
2. Click the "Fork" Button in the upper right-hand corner of the interface ([More Details Here](https://help.github.com/articles/fork-a-repo/))
|
||||
|
||||
3. After the repository has been forked, you will be taken to your copy of the freeCodeCamp repository at `https://github.com/YOUR_USER_NAME/freeCodeCamp` (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
How to fork freeCodeCamp on GitHub (screenshot)
|
||||
</summary>
|
||||
|
||||
<br>
|
||||
<img src="https://raw.githubusercontent.com/freeCodeCamp/freeCodeCamp/main/docs/images/github/how-to-fork-freeCodeCamp.gif" alt="How to fork freeCodeCamp on GitHub" />
|
||||
</details>
|
||||
|
||||
## 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`. (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
@@ -279,9 +287,9 @@ If you have issues while installing it, check out the [troubleshooting section](
|
||||
|
||||
A quick reference to the commands that you will need when working locally.
|
||||
|
||||
| comando | descripción |
|
||||
| ------------------ | ------------------------------------------------------------------------------ |
|
||||
| `pnpm install` | Instala / reinstala todas las dependencias y arranca los diferentes servicios. |
|
||||
| `pnpm run seed` | Creates authorized test users and inserts them into mongodb. |
|
||||
| `pnpm run develop` | Inicia el servidor freeCodeCamp API y las aplicaciones de cliente. |
|
||||
| `pnpm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
| command | description |
|
||||
| ------------------ | ----------------------------------------------------------------------------- |
|
||||
| `pnpm install` | Installs / re-install all dependencies and bootstraps the different services. |
|
||||
| `pnpm run seed` | Creates authorized test users and inserts them into mongodb. |
|
||||
| `pnpm run develop` | Starts the freeCodeCamp API Server and Client Applications. |
|
||||
| `pnpm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
|
||||
@@ -1,45 +1,23 @@
|
||||
Befolge diese Richtlinien, um freeCodeCamp lokal auf deinem System einzurichten. Das ist sehr empfehlenswert, wenn du regelmäßig einen Beitrag leisten willst.
|
||||
Follow these guidelines for setting up a development environment for freeCodeCamp. Das ist sehr empfehlenswert, wenn du regelmäßig einen Beitrag leisten willst.
|
||||
|
||||
Für einige dieser Arbeitsabläufe - wie das Beheben von Fehlern in der Codebasis oder im Studienplan - musst du freeCodeCamp lokal auf deinem Computer ausführen.
|
||||
## Choose between Gitpod or your own machine (local setup)
|
||||
|
||||
> [!TIP] If you are not interested in setting up freeCodeCamp locally, consider using Gitpod. We have automated the process of installing all the dependencies & tools you will need.
|
||||
>
|
||||
> Continue reading this guide to learn more about using GitPod.
|
||||
If you are looking to make a one-off contribution, you should use Gitpod to make changes. The Gitpod setup launches a ready-to-code environment in a few minutes in your web browser. For contributing long-term, we recommend you setup freeCodeCamp on your local machine.
|
||||
|
||||
## Forke das Repository auf GitHub
|
||||
Here are some pros and cons which should help you decide which option is best for you:
|
||||
|
||||
[Forking](https://help.github.com/articles/about-forks/) is a step where you get your own copy of freeCodeCamp's main repository (a.k.a _repo_) on GitHub.
|
||||
| Gitpod | Your own machine (local setup) |
|
||||
| ----------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| No minimum hardware requirements | Specific and minimum requirements |
|
||||
| No need to install any software | Additional software required |
|
||||
| Always up to date copy of repository | Need to maintain a local copy of the repository |
|
||||
| Slower and can take a few minutes to launch | Faster and can be launched in seconds |
|
||||
| Need an internet connection to work | Minimal internet connection required (once setup) |
|
||||
| Some tasks like compilation and tests can take longer to complete | Faster completion of tasks (depending on your machine's capabilities) |
|
||||
|
||||
This is essential, as it allows you to work on your own copy of freeCodeCamp on GitHub, or to download (clone) your repository to work on locally. Later, you will be able to request changes to be pulled into the main repository from your fork via a pull request (PR).
|
||||
> [!ATTENTION] **Note:** If you are using Windows 10 or 11, you will need to use WSL2. You can follow [this guide](how-to-setup-wsl.md) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.
|
||||
|
||||
> [!TIP] The main repository at `https://github.com/freeCodeCamp/freeCodeCamp` is often referred to as the `upstream` repository.
|
||||
>
|
||||
> Your fork at `https://github.com/YOUR_USER_NAME/freeCodeCamp` is often referred to as the `origin` repository. `YOUR_USER_NAME` would be replaced with your GitHub username.
|
||||
|
||||
**Follow these steps to fork the `https://github.com/freeCodeCamp/freeCodeCamp` repository:**
|
||||
|
||||
1. Go to the freeCodeCamp repository on GitHub: <https://github.com/freeCodeCamp/freeCodeCamp>
|
||||
|
||||
2. Click the "Fork" Button in the upper right-hand corner of the interface ([More Details Here](https://help.github.com/articles/fork-a-repo/))
|
||||
|
||||
3. After the repository has been forked, you will be taken to your copy of the freeCodeCamp repository at `https://github.com/YOUR_USER_NAME/freeCodeCamp` (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
How to fork freeCodeCamp on GitHub (screenshot)
|
||||
</summary>
|
||||
|
||||
<br>
|
||||
<img src="https://raw.githubusercontent.com/freeCodeCamp/freeCodeCamp/main/docs/images/github/how-to-fork-freeCodeCamp.gif" alt="How to fork freeCodeCamp on GitHub" />
|
||||
</details>
|
||||
|
||||
## Use a Local Machine or GitPod
|
||||
|
||||
Once you have forked the repository, you can either use your own local machine or a GitPod-based workspace to work on the codebase.
|
||||
|
||||
For contributing long-term, we recommend you setup freeCodeCamp on your local machine.
|
||||
|
||||
### How to prepare a GitPod workspace
|
||||
### How to prepare a Gitpod workspace
|
||||
|
||||
We have automated the process of installing all the dependencies & tools you will need. With GitPod you get a free ready-to-code environment in a few minutes, and is useful if you do not have access to computer or want to make one-time changes.
|
||||
|
||||
@@ -62,21 +40,24 @@ That's it, you can now skip to the 'syncing up from parent' section after you ha
|
||||
|
||||
### How to prepare your local machine
|
||||
|
||||
Here is a minimum system requirement for running freeCodeCamp locally:
|
||||
|
||||
- 8 GB RAM
|
||||
- Relatively fast CPU (4+ cores)
|
||||
- Windows 10 or 11 (with WSL), macOS, or Linux
|
||||
|
||||
Start by installing the prerequisite software for your operating system.
|
||||
|
||||
We primarily support development on Linux and Unix-based systems. Our staff and community contributors regularly work with the codebase using tools installed on Ubuntu and macOS.
|
||||
We primarily support development on Linux and Unix-based systems like Ubuntu and macOS. You can develop on Windows 10 or 11 with WSL2 only. You can follow [this guide](how-to-setup-wsl.md) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.
|
||||
|
||||
We also support Windows 10 and 11 via WSL2, which you can prepare by [reading this guide](how-to-setup-wsl.md).
|
||||
|
||||
Some community members also develop on Windows natively with Git for Windows (Git Bash), and other tools installed on Windows. We do not have official support for such a setup at this time, we recommend using WSL2 instead.
|
||||
|
||||
#### Voraussetzungen:
|
||||
|
||||
| Voraussetzung | Version | Notizen |
|
||||
| --------------------------------------------------------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| [Node.js](http://nodejs.org) | `18.x` | Wir verwenden die "Active LTS"-Version, siehe [LTS Schedule](https://nodejs.org/en/about/releases/). |
|
||||
| [pnpm](https://pnpm.io/installation) | `8.x` | - |
|
||||
| [MongoDB Community-Server](https://docs.mongodb.com/manual/administration/install-community/) | `4.2.x` | - |
|
||||
| Prerequisite | Version | Notes |
|
||||
| --------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------- |
|
||||
| [Node.js](http://nodejs.org) | `18.x` | We use the "Active LTS" version, See [LTS Schedule](https://nodejs.org/en/about/releases/). |
|
||||
| [pnpm](https://pnpm.io/installation) | `8.x` | - |
|
||||
| [MongoDB Community Server](https://docs.mongodb.com/manual/administration/install-community/) | `4.2.x` | - |
|
||||
|
||||
> [!ATTENTION] If you have a different version, please install the recommended version. We can only support installation issues for recommended versions. See [troubleshooting](#troubleshooting) for details.
|
||||
|
||||
@@ -107,6 +88,33 @@ Once you have the prerequisites installed, you need to prepare your development
|
||||
|
||||
> [!TIP] Please do not ignore any linting errors. They are meant to **help** you and to ensure a clean and simple codebase.
|
||||
|
||||
## Fork the repository on GitHub
|
||||
|
||||
[Forking](https://help.github.com/articles/about-forks/) is a step where you get your own copy of freeCodeCamp's main repository (a.k.a _repo_) on GitHub.
|
||||
|
||||
This is essential, as it allows you to work on your own copy of freeCodeCamp on GitHub, or to download (clone) your repository to work on locally. Later, you will be able to request changes to be pulled into the main repository from your fork via a pull request (PR).
|
||||
|
||||
> [!TIP] The main repository at `https://github.com/freeCodeCamp/freeCodeCamp` is often referred to as the `upstream` repository.
|
||||
>
|
||||
> Your fork at `https://github.com/YOUR_USER_NAME/freeCodeCamp` is often referred to as the `origin` repository. `YOUR_USER_NAME` would be replaced with your GitHub username.
|
||||
|
||||
**Follow these steps to fork the `https://github.com/freeCodeCamp/freeCodeCamp` repository:**
|
||||
|
||||
1. Go to the freeCodeCamp repository on GitHub: <https://github.com/freeCodeCamp/freeCodeCamp>
|
||||
|
||||
2. Click the "Fork" Button in the upper right-hand corner of the interface ([More Details Here](https://help.github.com/articles/fork-a-repo/))
|
||||
|
||||
3. After the repository has been forked, you will be taken to your copy of the freeCodeCamp repository at `https://github.com/YOUR_USER_NAME/freeCodeCamp` (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
How to fork freeCodeCamp on GitHub (screenshot)
|
||||
</summary>
|
||||
|
||||
<br>
|
||||
<img src="https://raw.githubusercontent.com/freeCodeCamp/freeCodeCamp/main/docs/images/github/how-to-fork-freeCodeCamp.gif" alt="How to fork freeCodeCamp on GitHub" />
|
||||
</details>
|
||||
|
||||
## 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`. (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
@@ -279,9 +287,9 @@ If you have issues while installing it, check out the [troubleshooting section](
|
||||
|
||||
A quick reference to the commands that you will need when working locally.
|
||||
|
||||
| Befehl | Beschreibung |
|
||||
| ------------------ | ------------------------------------------------------------------------------------- |
|
||||
| `pnpm install` | Installiert / reinstalliert alle Abhängigkeiten und bootet die verschiedenen Dienste. |
|
||||
| `pnpm run seed` | Creates authorized test users and inserts them into mongodb. |
|
||||
| `pnpm run develop` | Startet den freeCodeCamp API Server und die Client-Anwendungen. |
|
||||
| `pnpm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
| command | description |
|
||||
| ------------------ | ----------------------------------------------------------------------------- |
|
||||
| `pnpm install` | Installs / re-install all dependencies and bootstraps the different services. |
|
||||
| `pnpm run seed` | Creates authorized test users and inserts them into mongodb. |
|
||||
| `pnpm run develop` | Starts the freeCodeCamp API Server and Client Applications. |
|
||||
| `pnpm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
|
||||
@@ -1,121 +1,129 @@
|
||||
Segui queste linee guida per impostare freeCodeCamp localmente nel tuo sistema. Te lo raccomandiamo caldamente se desideri contribuire regolarmente.
|
||||
Follow these guidelines for setting up a development environment for freeCodeCamp. Te lo raccomandiamo caldamente se desideri contribuire regolarmente.
|
||||
|
||||
Alcuni di questi flussi di lavoro contributivi – come la correzione di bug nel codebase o nel curriculum – hanno bisogno di eseguire freeCodeCamp localmente sul computer.
|
||||
## Choose between Gitpod or your own machine (local setup)
|
||||
|
||||
> [!TIP] Se non sei interessato a configurare freeCodeCamp localmente, considera di utilizzare Gitpod. Abbiamo automatizzato il processo di installazione di tutte le dipendenze & degli strumenti di cui avrai bisogno.
|
||||
>
|
||||
> Continua a leggere questa guida per saperne di più sull'uso di GitPod.
|
||||
If you are looking to make a one-off contribution, you should use Gitpod to make changes. The Gitpod setup launches a ready-to-code environment in a few minutes in your web browser. For contributing long-term, we recommend you setup freeCodeCamp on your local machine.
|
||||
|
||||
## Esegui il fork del repository su GitHub
|
||||
Here are some pros and cons which should help you decide which option is best for you:
|
||||
|
||||
Il [Forking](https://help.github.com/articles/about-forks/) è un passaggio nel quale fai una copia del repository principale di freeCodeCamp (noto anche come _repo_) su GitHub.
|
||||
| Gitpod | Your own machine (local setup) |
|
||||
| ----------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| No minimum hardware requirements | Specific and minimum requirements |
|
||||
| No need to install any software | Additional software required |
|
||||
| Always up to date copy of repository | Need to maintain a local copy of the repository |
|
||||
| Slower and can take a few minutes to launch | Faster and can be launched in seconds |
|
||||
| Need an internet connection to work | Minimal internet connection required (once setup) |
|
||||
| Some tasks like compilation and tests can take longer to complete | Faster completion of tasks (depending on your machine's capabilities) |
|
||||
|
||||
Questo è essenziale, in quanto consente di lavorare sulla propria copia di freeCodeCamp su GitHub, o di scaricare (clonare) il tuo repository per lavorare localmente. Più tardi, potrai richiedere che le tue modifiche siano integrate nel repository principale dal tuo fork tramite una pull request (PR).
|
||||
> [!ATTENTION] **Note:** If you are using Windows 10 or 11, you will need to use WSL2. You can follow [this guide](how-to-setup-wsl.md) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.
|
||||
|
||||
> [!TIP] Il repository principale su `https://github.com/freeCodeCamp/freeCodeCamp` è spesso indicato come il repository `upstream`.
|
||||
>
|
||||
> Il tuo fork situato su `https://github.com/YOUR_USER_NAME/freeCodeCamp` è spesso chiamato il repository `origin`. `YOUR_USER_NAME` è sostituito dal tuo nome utente GitHub.
|
||||
### How to prepare a Gitpod workspace
|
||||
|
||||
**Segui questi passaggi per effettuare il fork del repository `https://github.com/freeCodeCamp/freeCodeCamp`:**
|
||||
We have automated the process of installing all the dependencies & tools you will need. With GitPod you get a free ready-to-code environment in a few minutes, and is useful if you do not have access to computer or want to make one-time changes.
|
||||
|
||||
1. Vai al repository freeCodeCamp su GitHub: <https://github.com/freeCodeCamp/freeCodeCamp>
|
||||
There are various ways to launch an GitPod workspace:
|
||||
|
||||
2. Fai clic sul pulsante "Fork" nell'angolo in alto a destra dell'interfaccia ([Maggiori dettagli qui](https://help.github.com/articles/fork-a-repo/))
|
||||
1. **(Fastest)** Prepend `gitpod.io/#` in front of any URL from GitHub.
|
||||
|
||||
3. Dopo che è stato creato un fork del repository, sarai portato alla tua copia del repository di freeCodeCamp su `https://github.com/YOUR_USER_NAME/freeCodeCamp` (`YOUR_USER_NAME` è sostituito dal tuo nome utente GitHub.)
|
||||
For example, if you visit your fork at `https://github.com/YOUR_USER_NAME/freeCodeCamp.git`, add `gitpod.io/#` in the front of the URL in the address bar and hit enter.
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
Come effettuare il fork di freeCodeCamp su GitHub (screenshot)
|
||||
</summary>
|
||||
That is you can navigate to `gitpod.io/#https://github.com/YOUR_USER_NAME/freeCodeCamp.git` and you should see a workspace created for you. This works for any repository or pull-request on GitHub.
|
||||
|
||||
<br>
|
||||
<img src="https://raw.githubusercontent.com/freeCodeCamp/freeCodeCamp/main/docs/images/github/how-to-fork-freeCodeCamp.gif" alt="Come fare il fork di freeCodeCamp su GitHub" />
|
||||
</details>
|
||||
|
||||
## Usare una macchina locale o GitPod
|
||||
|
||||
Una volta eseguito il fork del repository, puoi utilizzare la tua macchina locale o uno spazio di lavoro basato su Gitpod per lavorare sul codebase.
|
||||
|
||||
Per contribuire a lungo termine, ti consigliamo di impostare freeCodeCamp sulla tua macchina locale.
|
||||
|
||||
### Come preparare uno spazio di lavoro GitPod
|
||||
|
||||
Abbiamo automatizzato il processo di installazione di tutte le dipendenze & degli strumenti di cui avrai bisogno. Con GitPod ottieni un ambiente gratuito pronto per programmare in pochi minuti, ed è utile se non hai accesso al computer o se desideri effettuare modifiche una tantum.
|
||||
|
||||
Ci sono vari modi per avviare uno spazio di lavoro GitPod:
|
||||
|
||||
1. **(Il più veloce)** Anteponi `gitpod.io/#` a ogni URL di GitHub.
|
||||
|
||||
Ad esempio, se visiti il tuo fork su `https://github.com/YOUR_USER_NAME/freeCodeCamp.git`, aggiungi `gitpod.io/#` davanti all'URL nella barra degli indirizzi e premi invio.
|
||||
|
||||
Cioè puoi andare su `gitpod.io/#https://github.com/YOUR_USER_NAME/freeCodeCamp.git` e dovresti vedere uno spazio di lavoro creato per te. Funziona per qualsiasi repository o pull-request su GitHub.
|
||||
|
||||
2. In alternativa, installa una delle estensioni sottostanti per il browser.
|
||||
2. Alternatively install one of the below extensions for your browser.
|
||||
|
||||
- [Chrome Webstore](https://chrome.google.com/webstore/detail/gitpod-always-ready-to-co/dodmmooeoklaejobgleioelladacbeki) - funziona con browser basati su Chromium come Google Chrome, Brave, Edge, ecc.
|
||||
- [Firefox Add-on](https://addons.mozilla.org/en-US/firefox/addon/gitpod) - Firefox
|
||||
|
||||
Una volta installato vedrai un pulsante 'GitPod' su ogni repository, pull-request, ecc. da usare come una comoda scorciatoia per lanciare uno spazio di lavoro. Vedi la pagina delle estensioni per i dettagli, screenshot, ecc.
|
||||
|
||||
Questo è tutto, ora puoi saltare alla sezione 'impostare la sincronizzazione dal genitore' dopo aver lanciato uno spazio di lavoro GitPod. Molte parti di questa guida si applicano a spazi di lavoro GitPod, ma sii cosciente di [come funzionano URL & Porte in uno spazio di lavoro GitPod](https://www.gitpod.io/docs/configure/workspaces/ports).
|
||||
That's it, you can now skip to the 'syncing up from parent' section after you have launched a GitPod workspace. Most parts of this guide applies to GitPod workspaces, but be mindful of [how the URLs & Ports work within a GitPod](https://www.gitpod.io/docs/configure/workspaces/ports) workspace.
|
||||
|
||||
### Come preparare la macchina locale
|
||||
|
||||
Inizia installando i prerequisiti software per il tuo sistema operativo.
|
||||
Here is a minimum system requirement for running freeCodeCamp locally:
|
||||
|
||||
Sosteniamo principalmente lo sviluppo su sistemi Linux e basati su Unix. Il nostro staff e i collaboratori della community lavorano regolarmente con il codebase utilizzando strumenti installati su Ubuntu e macOS.
|
||||
- 8 GB RAM
|
||||
- Relatively fast CPU (4+ cores)
|
||||
- Windows 10 or 11 (with WSL), macOS, or Linux
|
||||
|
||||
Supportiamo anche Windows 10 e 11 via WSL2, che puoi preparare [leggendo questa guida](how-to-setup-wsl.md).
|
||||
Start by installing the prerequisite software for your operating system.
|
||||
|
||||
We primarily support development on Linux and Unix-based systems like Ubuntu and macOS. You can develop on Windows 10 or 11 with WSL2 only. You can follow [this guide](how-to-setup-wsl.md) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.
|
||||
|
||||
Alcuni membri della comunità sviluppano anche su Windows nativamente con Git per Windows (Git Bash) e altri strumenti installati su Windows. Al momento non disponiamo di un supporto ufficiale per una tale configurazione, consigliamo invece di utilizzare WSL2.
|
||||
|
||||
#### Prerequisiti:
|
||||
|
||||
| Prerequisito | Versione | Note |
|
||||
| --------------------------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------- |
|
||||
| [Node.js](http://nodejs.org) | `18.x` | Usiamo la versione "Active LTS", Vedi [LTS Schedule](https://nodejs.org/en/about/releases/). |
|
||||
| [pnpm](https://pnpm.io/installation) | `8.x` | - |
|
||||
| [Server Community MongoDB](https://docs.mongodb.com/manual/administration/install-community/) | `4.2.x` | - |
|
||||
| Prerequisite | Version | Notes |
|
||||
| --------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------- |
|
||||
| [Node.js](http://nodejs.org) | `18.x` | We use the "Active LTS" version, See [LTS Schedule](https://nodejs.org/en/about/releases/). |
|
||||
| [pnpm](https://pnpm.io/installation) | `8.x` | - |
|
||||
| [MongoDB Community Server](https://docs.mongodb.com/manual/administration/install-community/) | `4.2.x` | - |
|
||||
|
||||
> [!ATTENTION] Se hai una versione diversa, per favore installa la versione raccomandata. Possiamo supportare solo i problemi di installazione per le versioni consigliate. Vedi [risoluzione dei problemi](#troubleshooting) per i dettagli.
|
||||
> [!ATTENTION] If you have a different version, please install the recommended version. We can only support installation issues for recommended versions. See [troubleshooting](#troubleshooting) for details.
|
||||
|
||||
Se Node.js è già installato sulla macchina, esegui i seguenti comandi per convalidare le versioni:
|
||||
If Node.js is already installed on your machine, run the following commands to validate the versions:
|
||||
|
||||
```console
|
||||
node -v
|
||||
pnpm -v
|
||||
```
|
||||
|
||||
> [!TIP] Consigliamo vivamente di aggiornare le ultime versioni stabili del software sopra elencato, note anche come versioni con supporto a lungo termine (LTS).
|
||||
> [!TIP] We highly recommend updating to the latest stable releases of the software listed above, also known as Long Term Support (LTS) releases.
|
||||
|
||||
Una volta che avrai installato i prerequisiti, dovrai preparare il tuo ambiente di sviluppo. Questo è comune a molti flussi di lavoro di sviluppo, e dovrai farlo solo una volta.
|
||||
Once you have the prerequisites installed, you need to prepare your development environment. This is common for many development workflows, and you will only need to do this once.
|
||||
|
||||
##### Segui questi passaggi per preparare il tuo ambiente di sviluppo:
|
||||
|
||||
1. Installa [Git](https://git-scm.com/) o il tuo client Git preferito, se non lo hai già. Aggiorna alla versione più recente; la versione fornita con il tuo sistema operativo potrebbe essere obsoleta.
|
||||
1. Install [Git](https://git-scm.com/) or your favorite Git client, if you haven't already. Update to the latest version; the version that came bundled with your OS may be outdated.
|
||||
|
||||
2. (Opzionale ma raccomandato) [Imposta una chiave SSH](https://help.github.com/articles/generating-an-ssh-key/) per GitHub.
|
||||
2. (Optional but recommended) [Set up an SSH Key](https://help.github.com/articles/generating-an-ssh-key/) for GitHub.
|
||||
|
||||
3. Installa un editor di codice di tua scelta.
|
||||
3. Install a code editor of your choice.
|
||||
|
||||
Consigliamo vivamente di utilizzare [Visual Studio Code](https://code.visualstudio.com/) o [Atom](https://atom.io/). Si tratta di ottimi editor di codice, gratuiti e open source.
|
||||
We highly recommend using [Visual Studio Code](https://code.visualstudio.com/) or [Atom](https://atom.io/). These are great, free and open source code editors.
|
||||
|
||||
4. Imposta il linting per il tuo editor di codice.
|
||||
4. Set up linting for your code editor.
|
||||
|
||||
Dovresti avere [ESLint in esecuzione nel tuo editor](http://eslint.org/docs/user-guide/integrations.html), e metterà in evidenza tutto ciò che non è conforme alla [Guida di stile JavaScript di freeCodeCamp](http://forum.freecodecamp.org/t/free-code-camp-javascript-style-guide/19121).
|
||||
You should have [ESLint running in your editor](http://eslint.org/docs/user-guide/integrations.html), and it will highlight anything that doesn't conform to [freeCodeCamp's JavaScript Style Guide](http://forum.freecodecamp.org/t/free-code-camp-javascript-style-guide/19121).
|
||||
|
||||
> [!TIP] Per favore non ignorare alcun errore di linting. Sono pensati per **aiutarti** e per garantire un codice pulito e semplice.
|
||||
> [!TIP] Please do not ignore any linting errors. They are meant to **help** you and to ensure a clean and simple codebase.
|
||||
|
||||
## Fork the repository on GitHub
|
||||
|
||||
[Forking](https://help.github.com/articles/about-forks/) is a step where you get your own copy of freeCodeCamp's main repository (a.k.a _repo_) on GitHub.
|
||||
|
||||
This is essential, as it allows you to work on your own copy of freeCodeCamp on GitHub, or to download (clone) your repository to work on locally. Later, you will be able to request changes to be pulled into the main repository from your fork via a pull request (PR).
|
||||
|
||||
> [!TIP] The main repository at `https://github.com/freeCodeCamp/freeCodeCamp` is often referred to as the `upstream` repository.
|
||||
>
|
||||
> Your fork at `https://github.com/YOUR_USER_NAME/freeCodeCamp` is often referred to as the `origin` repository. `YOUR_USER_NAME` would be replaced with your GitHub username.
|
||||
|
||||
**Follow these steps to fork the `https://github.com/freeCodeCamp/freeCodeCamp` repository:**
|
||||
|
||||
1. Go to the freeCodeCamp repository on GitHub: <https://github.com/freeCodeCamp/freeCodeCamp>
|
||||
|
||||
2. Click the "Fork" Button in the upper right-hand corner of the interface ([More Details Here](https://help.github.com/articles/fork-a-repo/))
|
||||
|
||||
3. After the repository has been forked, you will be taken to your copy of the freeCodeCamp repository at `https://github.com/YOUR_USER_NAME/freeCodeCamp` (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
How to fork freeCodeCamp on GitHub (screenshot)
|
||||
</summary>
|
||||
|
||||
<br>
|
||||
<img src="https://raw.githubusercontent.com/freeCodeCamp/freeCodeCamp/main/docs/images/github/how-to-fork-freeCodeCamp.gif" alt="How to fork freeCodeCamp on GitHub" />
|
||||
</details>
|
||||
|
||||
## Clonare il tuo fork da GitHub
|
||||
|
||||
La [Clonazione](https://help.github.com/articles/cloning-a-repository/) consiste nello **scaricare** una copia di un repository da una `posizione remota` che è di proprietà tua o di qualcun altro. Nel tuo caso, questa posizione remota è il tuo `fork` del repository di freeCodeCamp che dovrebbe essere disponibile su `https://github.com/YOUR_USER_NAME/freeCodeCamp`. (`YOUR_USER_NAME` è sostituito dal tuo nome utente 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`. (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
|
||||
> [!WARNING] Se stai lavorando su una Distro di Linux su WSL2, potresti avere problemi di performance e stabilità eseguendo il progetto in una cartella che è condivisa tra Windows e WSL2 (per esempio `/mnt/c/Users/`). Quindi ti raccomandiamo di clonare il repo in una cartella che è usata principalmente dalla Distro di Linux su WSL2 e non condivisa direttamente con Windows (per esempio `~/PROJECTS/`).
|
||||
>
|
||||
> Vedi [questa issue su GitHub](https://github.com/freeCodeCamp/freeCodeCamp/issues/40632) per ulteriori informazioni su questo problema.
|
||||
|
||||
Esegui questi comandi sulla tua macchina locale:
|
||||
Run these commands on your local machine:
|
||||
|
||||
1. Apri un terminale / prompt dei comandi / Shell nella directory dei progetti
|
||||
|
||||
@@ -127,17 +135,17 @@ Esegui questi comandi sulla tua macchina locale:
|
||||
git clone --depth=1 https://github.com/YOUR_USER_NAME/freeCodeCamp.git
|
||||
```
|
||||
|
||||
Questo scaricherà l'intero repository freeCodeCamp nella directory dei tuoi progetti.
|
||||
This will download the entire freeCodeCamp repository to your projects directory.
|
||||
|
||||
Nota: `--depth=1` crea un clone superficiale del fork, con la sola cronologia dei commit più recente.
|
||||
Note: `--depth=1` creates a shallow clone of your fork, with only the most recent history/commit.
|
||||
|
||||
## Impostare la sincronizzazione dal genitore
|
||||
|
||||
Ora che hai scaricato una copia del fork, dovrai configurare un `upstream` remoto che punta al repository genitore.
|
||||
Now that you have downloaded a copy of your fork, you will need to set up an `upstream` remote to the parent repository.
|
||||
|
||||
[Come già accennato](#fork-the-repository-on-github), il repository principale fa riferimento al repository `upstream`. Il tuo fork è chiamato repository `origin`.
|
||||
[As mentioned earlier](#fork-the-repository-on-github), the main repository is referred `upstream` repository. Your fork referred to as the `origin` repository.
|
||||
|
||||
Hai bisogno di un riferimento dal tuo clone locale al repository `upstream` oltre al repository `origin`. In questo modo potrai sincronizzare le modifiche dal repository principale senza bisogno di fare ripetuti fork e clonazioni.
|
||||
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. Cambia la directory nella nuova directory freeCodeCamp:
|
||||
|
||||
@@ -168,21 +176,21 @@ Hai bisogno di un riferimento dal tuo clone locale al repository `upstream` oltr
|
||||
|
||||
## Eseguire freeCodeCamp localmente
|
||||
|
||||
Ora che disponi di una copia locale di freeCodeCamp, potrai seguire queste istruzioni per eseguirlo localmente. Questo ti permetterà di:
|
||||
Now that you have a local copy of freeCodeCamp, you can follow these instructions to run it locally. This will allow you to:
|
||||
|
||||
- Vedere un'anteprima delle modifiche come apparirebbero sulla piattaforma di apprendimento.
|
||||
- Lavorare su problemi e miglioramenti relativi all'interfaccia utente.
|
||||
- Fare il debug e la correzione dei problemi con i server delle applicazioni e le app client.
|
||||
- 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.
|
||||
|
||||
Se incontri un problema, fai prima una ricerca del problema sul web per vedere se ha già una risposta. Se non riesci a trovare una soluzione, ti preghiamo di fare una ricerca nelle nostra pagina delle [Issues su GitHub](https://github.com/freeCodeCamp/freeCodeCamp/issues) per trovare una soluzione o segnalare il problema se non è ancora stato fatto.
|
||||
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.
|
||||
|
||||
E come sempre, fai liberamente le tue domande nella [categoria 'Contributors' sul forum](https://forum.freecodecamp.org/c/contributors) o [sul server di chat](https://discord.gg/PRyKn3Vbay).
|
||||
And as always, feel free to ask questions on the ['Contributors' category on our forum](https://forum.freecodecamp.org/c/contributors) or [our chat server](https://discord.gg/PRyKn3Vbay).
|
||||
|
||||
### Configurare le dipendenze
|
||||
|
||||
#### Passo 1: Impostare il file delle variabili d'ambiente
|
||||
|
||||
Le chiavi API predefinite e le variabili d'ambiente sono memorizzate nel file `sample.env`. Questo file deve essere copiato in un nuovo file chiamato `.env` a cui si accede dinamicamente durante la fase di installazione.
|
||||
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
|
||||
# Creare una copia del "sample.env" e denominarlo ".env".
|
||||
@@ -205,13 +213,13 @@ copy sample.env .env
|
||||
|
||||
<!-- tabs:end -->
|
||||
|
||||
_Non_ è necessario cambiare le chiavi nel file `.env` per eseguire l'applicazione localmente. Puoi lasciare i valori predefiniti copiati da `sample.env` così come sono.
|
||||
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] Tieni a mente che se vuoi usare servizi come Auth0 o Algolia, dovrai ottenere delle chiavi API per questi servizi per conto tuo e modificare gli elementi nel file `.env` di conseguenza.
|
||||
|
||||
#### Passo 2: Installa le dipendenze
|
||||
|
||||
Questo passaggio installerà le dipendenze richieste per l'esecuzione dell'applicazione:
|
||||
This step will install the dependencies required for the application to run:
|
||||
|
||||
```console
|
||||
pnpm install
|
||||
@@ -219,13 +227,13 @@ pnpm install
|
||||
|
||||
#### Passo 3: Avvia MongoDB e fai il seed del database
|
||||
|
||||
Prima di poter eseguire l'applicazione localmente, è necessario avviare il servizio MongoDB.
|
||||
Before you can run the application locally, you will need to start the MongoDB service.
|
||||
|
||||
> [!NOTE] A meno che tu non abbia MongoDB in esecuzione in un setup differente da quello predefinito, l'URL salvato come `MONGOHQ_URL` nel file `.env` dovrebbe andare bene. Se usi una configurazione personalizzata, modifica il valore come necessario.
|
||||
>
|
||||
> Se hai seguito la [Guida di configurazione Windows 10 via WSL2](how-to-setup-wsl.md), allora dovresti essere in grado di saltare questo passaggio se il server MongoDB di quella guida è già in esecuzione. Puoi averne conferma controllando di poter raggiungere `http://localhost:27017` sulla tua macchina locale.
|
||||
|
||||
Avvia il server MongoDB in un terminale separato:
|
||||
Start the MongoDB server in a separate terminal:
|
||||
|
||||
<!-- tabs:start -->
|
||||
|
||||
@@ -237,19 +245,19 @@ mongod
|
||||
|
||||
#### **Windows**
|
||||
|
||||
- Su Windows, è necessario specificare il percorso completo dell'eseguibile `mongod`
|
||||
- On Windows, you must specify the full path to the `mongod` binary
|
||||
|
||||
```console
|
||||
"C:\Program Files\MongoDB\Server\3.6\bin\mongod"
|
||||
```
|
||||
|
||||
Assicurati di sostituire `3.6` con la versione che hai installato
|
||||
Make sure to replace `3.6` with the version you have installed
|
||||
|
||||
<!-- tabs:end -->
|
||||
|
||||
> [!TIP] Puoi evitare di dover avviare MongoDB ogni volta se lo installi come servizio in background. Puoi [saperne di più nella loro documentazione per il tuo sistema operativo](https://docs.mongodb.com/manual/administration/install-community/)
|
||||
|
||||
Successivamente, facciamo il seed del database. In questo passaggio, eseguiamo il comando sottostante che popola il server MongoDB con alcuni set di dati iniziali richiesti dai servizi. Tra questi figurano alcuni schemi, tra le altre cose.
|
||||
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
|
||||
pnpm run seed
|
||||
@@ -257,31 +265,31 @@ pnpm run seed
|
||||
|
||||
#### Passo 4: Avviare l'applicazione client freeCodeCamp e il server API
|
||||
|
||||
Ora è possibile avviare il server API e le applicazioni client.
|
||||
You can now start up the API server and the client applications.
|
||||
|
||||
```console
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
Questo singolo comando attiverà tutti i servizi, compreso il server API e le applicazioni client disponibili su cui lavorare.
|
||||
This single command will fire up all the services, including the API server and the client applications available for you to work on.
|
||||
|
||||
Una volta pronto, apri un browser web e **visita <http://localhost:8000>**. Se l'app si carica, accedi. Congratulazioni – sei pronto! Hai ora una copia dell'intera piattaforma di apprendimento di freeCodeCamp in esecuzione sul tuo computer.
|
||||
Once ready, open a web browser and **visit <http://localhost:8000>**. If the app loads, sign in. Congratulations – you're all set! You now have a copy of freeCodeCamp's entire learning platform running on your local machine.
|
||||
|
||||
Il server API serve gli endpoint su `http://localhost:3000`. L'app Gatsby serve il client dell'applicazione su `http://localhost:8000`
|
||||
The API serves endpoints at `http://localhost:3000`. The Gatsby app serves the client application at `http://localhost:8000`
|
||||
|
||||
Mentre hai effettuato l'accesso, se visiti <http://localhost:3000/explorer> dovresti vedere le API disponibili.
|
||||
While you are logged in, if you visit <http://localhost:3000/explorer> you should see the available APIs.
|
||||
|
||||
> [!WARNING] Se pulisci i cookie o esegui `pnpm run seed:certified-user` perderai l'accesso e dovrai fare di nuovo l'accesso.
|
||||
|
||||
Se hai problemi durante l'installazione, consulta la sezione [risoluzione dei problemi](troubleshooting-development-issues.md)
|
||||
If you have issues while installing it, check out the [troubleshooting section](troubleshooting-development-issues.md)
|
||||
|
||||
## Comandi rapidi
|
||||
|
||||
Un rapido richiamo ai comandi di cui avrai bisogno quando lavorerai localmente.
|
||||
A quick reference to the commands that you will need when working locally.
|
||||
|
||||
| comando | descrizione |
|
||||
| ------------------ | -------------------------------------------------------------------- |
|
||||
| `pnpm install` | Installa / reinstalla tutte le dipendenze e avvia i diversi servizi. |
|
||||
| `pnpm run seed` | Crea utenti di test autorizzati e li inserisce in mongodb. |
|
||||
| `pnpm run develop` | Avvia il server API freeCodeCamp e le applicazioni client. |
|
||||
| `pnpm run clean` | Disistalla tutte le dipendenze e pulisce la cache. |
|
||||
| command | description |
|
||||
| ------------------ | ----------------------------------------------------------------------------- |
|
||||
| `pnpm install` | Installs / re-install all dependencies and bootstraps the different services. |
|
||||
| `pnpm run seed` | Creates authorized test users and inserts them into mongodb. |
|
||||
| `pnpm run develop` | Starts the freeCodeCamp API Server and Client Applications. |
|
||||
| `pnpm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
|
||||
@@ -1,45 +1,23 @@
|
||||
これらのガイドラインに従い、ローカルシステム上に freeCodeCamp を設定してください。 定期的に貢献したい場合に、強くお勧めします。
|
||||
Follow these guidelines for setting up a development environment for freeCodeCamp. 定期的に貢献したい場合に、強くお勧めします。
|
||||
|
||||
コードベースやカリキュラムのバグを修正するなど、コントリビューションワークフローの中には、ローカルコンピュータ上で freeCodeCamp を実行する必要があるものがあります。
|
||||
## Choose between Gitpod or your own machine (local setup)
|
||||
|
||||
> [!TIP] If you are not interested in setting up freeCodeCamp locally, consider using Gitpod. We have automated the process of installing all the dependencies & tools you will need.
|
||||
>
|
||||
> Continue reading this guide to learn more about using GitPod.
|
||||
If you are looking to make a one-off contribution, you should use Gitpod to make changes. The Gitpod setup launches a ready-to-code environment in a few minutes in your web browser. For contributing long-term, we recommend you setup freeCodeCamp on your local machine.
|
||||
|
||||
## GitHub でリポジトリをフォークする
|
||||
Here are some pros and cons which should help you decide which option is best for you:
|
||||
|
||||
[Forking](https://help.github.com/articles/about-forks/) is a step where you get your own copy of freeCodeCamp's main repository (a.k.a _repo_) on GitHub.
|
||||
| Gitpod | Your own machine (local setup) |
|
||||
| ----------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| No minimum hardware requirements | Specific and minimum requirements |
|
||||
| No need to install any software | Additional software required |
|
||||
| Always up to date copy of repository | Need to maintain a local copy of the repository |
|
||||
| Slower and can take a few minutes to launch | Faster and can be launched in seconds |
|
||||
| Need an internet connection to work | Minimal internet connection required (once setup) |
|
||||
| Some tasks like compilation and tests can take longer to complete | Faster completion of tasks (depending on your machine's capabilities) |
|
||||
|
||||
This is essential, as it allows you to work on your own copy of freeCodeCamp on GitHub, or to download (clone) your repository to work on locally. Later, you will be able to request changes to be pulled into the main repository from your fork via a pull request (PR).
|
||||
> [!ATTENTION] **Note:** If you are using Windows 10 or 11, you will need to use WSL2. You can follow [this guide](how-to-setup-wsl.md) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.
|
||||
|
||||
> [!TIP] The main repository at `https://github.com/freeCodeCamp/freeCodeCamp` is often referred to as the `upstream` repository.
|
||||
>
|
||||
> Your fork at `https://github.com/YOUR_USER_NAME/freeCodeCamp` is often referred to as the `origin` repository. `YOUR_USER_NAME` would be replaced with your GitHub username.
|
||||
|
||||
**Follow these steps to fork the `https://github.com/freeCodeCamp/freeCodeCamp` repository:**
|
||||
|
||||
1. Go to the freeCodeCamp repository on GitHub: <https://github.com/freeCodeCamp/freeCodeCamp>
|
||||
|
||||
2. Click the "Fork" Button in the upper right-hand corner of the interface ([More Details Here](https://help.github.com/articles/fork-a-repo/))
|
||||
|
||||
3. After the repository has been forked, you will be taken to your copy of the freeCodeCamp repository at `https://github.com/YOUR_USER_NAME/freeCodeCamp` (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
How to fork freeCodeCamp on GitHub (screenshot)
|
||||
</summary>
|
||||
|
||||
<br>
|
||||
<img src="https://raw.githubusercontent.com/freeCodeCamp/freeCodeCamp/main/docs/images/github/how-to-fork-freeCodeCamp.gif" alt="How to fork freeCodeCamp on GitHub" />
|
||||
</details>
|
||||
|
||||
## Use a Local Machine or GitPod
|
||||
|
||||
Once you have forked the repository, you can either use your own local machine or a GitPod-based workspace to work on the codebase.
|
||||
|
||||
For contributing long-term, we recommend you setup freeCodeCamp on your local machine.
|
||||
|
||||
### How to prepare a GitPod workspace
|
||||
### How to prepare a Gitpod workspace
|
||||
|
||||
We have automated the process of installing all the dependencies & tools you will need. With GitPod you get a free ready-to-code environment in a few minutes, and is useful if you do not have access to computer or want to make one-time changes.
|
||||
|
||||
@@ -62,21 +40,24 @@ That's it, you can now skip to the 'syncing up from parent' section after you ha
|
||||
|
||||
### How to prepare your local machine
|
||||
|
||||
Here is a minimum system requirement for running freeCodeCamp locally:
|
||||
|
||||
- 8 GB RAM
|
||||
- Relatively fast CPU (4+ cores)
|
||||
- Windows 10 or 11 (with WSL), macOS, or Linux
|
||||
|
||||
Start by installing the prerequisite software for your operating system.
|
||||
|
||||
We primarily support development on Linux and Unix-based systems. Our staff and community contributors regularly work with the codebase using tools installed on Ubuntu and macOS.
|
||||
We primarily support development on Linux and Unix-based systems like Ubuntu and macOS. You can develop on Windows 10 or 11 with WSL2 only. You can follow [this guide](how-to-setup-wsl.md) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.
|
||||
|
||||
We also support Windows 10 and 11 via WSL2, which you can prepare by [reading this guide](how-to-setup-wsl.md).
|
||||
|
||||
Some community members also develop on Windows natively with Git for Windows (Git Bash), and other tools installed on Windows. We do not have official support for such a setup at this time, we recommend using WSL2 instead.
|
||||
|
||||
#### 必要条件:
|
||||
|
||||
| 必要条件 | バージョン | 注 |
|
||||
| --------------------------------------------------------------------------------------- | ------- | ---------------------------------------------------------------------------------------- |
|
||||
| [Node.js](http://nodejs.org) | `18.x` | 「Active LTS」バージョンを使用しています。[LTS スケジュール](https://nodejs.org/en/about/releases/) を参照してください。 |
|
||||
| [pnpm](https://pnpm.io/installation) | `8.x` | - |
|
||||
| [MongoDB コミュニティサーバー](https://docs.mongodb.com/manual/administration/install-community/) | `4.2.x` | - |
|
||||
| Prerequisite | Version | Notes |
|
||||
| --------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------- |
|
||||
| [Node.js](http://nodejs.org) | `18.x` | We use the "Active LTS" version, See [LTS Schedule](https://nodejs.org/en/about/releases/). |
|
||||
| [pnpm](https://pnpm.io/installation) | `8.x` | - |
|
||||
| [MongoDB Community Server](https://docs.mongodb.com/manual/administration/install-community/) | `4.2.x` | - |
|
||||
|
||||
> [!ATTENTION] If you have a different version, please install the recommended version. We can only support installation issues for recommended versions. See [troubleshooting](#troubleshooting) for details.
|
||||
|
||||
@@ -107,6 +88,33 @@ Once you have the prerequisites installed, you need to prepare your development
|
||||
|
||||
> [!TIP] Please do not ignore any linting errors. They are meant to **help** you and to ensure a clean and simple codebase.
|
||||
|
||||
## Fork the repository on GitHub
|
||||
|
||||
[Forking](https://help.github.com/articles/about-forks/) is a step where you get your own copy of freeCodeCamp's main repository (a.k.a _repo_) on GitHub.
|
||||
|
||||
This is essential, as it allows you to work on your own copy of freeCodeCamp on GitHub, or to download (clone) your repository to work on locally. Later, you will be able to request changes to be pulled into the main repository from your fork via a pull request (PR).
|
||||
|
||||
> [!TIP] The main repository at `https://github.com/freeCodeCamp/freeCodeCamp` is often referred to as the `upstream` repository.
|
||||
>
|
||||
> Your fork at `https://github.com/YOUR_USER_NAME/freeCodeCamp` is often referred to as the `origin` repository. `YOUR_USER_NAME` would be replaced with your GitHub username.
|
||||
|
||||
**Follow these steps to fork the `https://github.com/freeCodeCamp/freeCodeCamp` repository:**
|
||||
|
||||
1. Go to the freeCodeCamp repository on GitHub: <https://github.com/freeCodeCamp/freeCodeCamp>
|
||||
|
||||
2. Click the "Fork" Button in the upper right-hand corner of the interface ([More Details Here](https://help.github.com/articles/fork-a-repo/))
|
||||
|
||||
3. After the repository has been forked, you will be taken to your copy of the freeCodeCamp repository at `https://github.com/YOUR_USER_NAME/freeCodeCamp` (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
How to fork freeCodeCamp on GitHub (screenshot)
|
||||
</summary>
|
||||
|
||||
<br>
|
||||
<img src="https://raw.githubusercontent.com/freeCodeCamp/freeCodeCamp/main/docs/images/github/how-to-fork-freeCodeCamp.gif" alt="How to fork freeCodeCamp on GitHub" />
|
||||
</details>
|
||||
|
||||
## 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`. (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
@@ -279,9 +287,9 @@ If you have issues while installing it, check out the [troubleshooting section](
|
||||
|
||||
A quick reference to the commands that you will need when working locally.
|
||||
|
||||
| コマンド | 説明 |
|
||||
| ------------------ | ------------------------------------------------------------ |
|
||||
| `pnpm install` | すべての依存関係をインストール / 再インストールし、異なるサービスをブートストラップします。 |
|
||||
| `pnpm run seed` | Creates authorized test users and inserts them into mongodb. |
|
||||
| `pnpm run develop` | freeCodeCamp の API サーバーとクライアントアプリケーションを起動します。 |
|
||||
| `pnpm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
| command | description |
|
||||
| ------------------ | ----------------------------------------------------------------------------- |
|
||||
| `pnpm install` | Installs / re-install all dependencies and bootstraps the different services. |
|
||||
| `pnpm run seed` | Creates authorized test users and inserts them into mongodb. |
|
||||
| `pnpm run develop` | Starts the freeCodeCamp API Server and Client Applications. |
|
||||
| `pnpm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
|
||||
@@ -1,121 +1,129 @@
|
||||
Siga estas diretrizes para configurar o freeCodeCamp localmente no seu sistema. Isso é altamente recomendado se você quer contribuir regularmente.
|
||||
Follow these guidelines for setting up a development environment for freeCodeCamp. Isso é altamente recomendado se você quer contribuir regularmente.
|
||||
|
||||
Alguns destes fluxos de trabalho de contribuição — como correção de erros na base de código ou currículo — necessitam do freeCodeCamp executando localmente em seu computador.
|
||||
## Choose between Gitpod or your own machine (local setup)
|
||||
|
||||
> [!TIP] Se você não tem interesse em configurar o freeCodeCamp localmente, considere usar o Gitpod. Nós automatizamos o processo de instalação de todas as dependências e ferramentas de que você precisará.
|
||||
>
|
||||
> Continue lendo este guia para saber mais sobre como usar o GitPod.
|
||||
If you are looking to make a one-off contribution, you should use Gitpod to make changes. The Gitpod setup launches a ready-to-code environment in a few minutes in your web browser. For contributing long-term, we recommend you setup freeCodeCamp on your local machine.
|
||||
|
||||
## Faça fork do repositório no GitHub
|
||||
Here are some pros and cons which should help you decide which option is best for you:
|
||||
|
||||
[Forking](https://help.github.com/articles/about-forks/) é uma etapa onde você obtém sua própria cópia do repositório principal do freeCodeCamp (vulgo _repo_) no GitHub.
|
||||
| Gitpod | Your own machine (local setup) |
|
||||
| ----------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| No minimum hardware requirements | Specific and minimum requirements |
|
||||
| No need to install any software | Additional software required |
|
||||
| Always up to date copy of repository | Need to maintain a local copy of the repository |
|
||||
| Slower and can take a few minutes to launch | Faster and can be launched in seconds |
|
||||
| Need an internet connection to work | Minimal internet connection required (once setup) |
|
||||
| Some tasks like compilation and tests can take longer to complete | Faster completion of tasks (depending on your machine's capabilities) |
|
||||
|
||||
Isso é essencial, pois permite que você trabalhe em sua própria cópia do freeCodeCamp no GitHub, ou fazer download (clone) do repositório para trabalhar localmente. Mais tarde, você poderá solicitar alterações para serem enviadas para o repositório principal através de um pull request (PR).
|
||||
> [!ATTENTION] **Note:** If you are using Windows 10 or 11, you will need to use WSL2. You can follow [this guide](how-to-setup-wsl.md) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.
|
||||
|
||||
> [!TIP] O repositório principal em `https://github.com/freeCodeCamp/freeCodeCamp` é frequentemente chamado de repositório `upstream`.
|
||||
>
|
||||
> Seu fork em `https://github.com/YOUR_USER_NAME/freeCodeCamp` frequentemente é referenciado como o repositório de `origin`. `YOUR_USER_NAME` será substituído pelo seu nome de usuário do GitHub.
|
||||
### How to prepare a Gitpod workspace
|
||||
|
||||
**Siga estes passos para criar um fork do repositório `https://github.com/freeCodeCamp/freeCodeCamp`:**
|
||||
We have automated the process of installing all the dependencies & tools you will need. With GitPod you get a free ready-to-code environment in a few minutes, and is useful if you do not have access to computer or want to make one-time changes.
|
||||
|
||||
1. Vá até o repositório freeCodeCamp no GitHub: <https://github.com/freeCodeCamp/freeCodeCamp>
|
||||
There are various ways to launch an GitPod workspace:
|
||||
|
||||
2. Clique no botão "Fork" no canto superior direito da interface ([Mais detalhes aqui](https://help.github.com/articles/fork-a-repo/))
|
||||
1. **(Fastest)** Prepend `gitpod.io/#` in front of any URL from GitHub.
|
||||
|
||||
3. Depois que o repositório recebeu um fork, você será redirecionado a cópia do repositório freeCodeCamp em `https://github.com/YOUR_USER_NAME/freeCodeCamp`(`YOUR_USER_NAME` será substituído pelo seu nome de usuário do GitHub.)
|
||||
For example, if you visit your fork at `https://github.com/YOUR_USER_NAME/freeCodeCamp.git`, add `gitpod.io/#` in the front of the URL in the address bar and hit enter.
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
Como criar um fork do freeCodeCamp no GitHub (foto da tela)
|
||||
</summary>
|
||||
That is you can navigate to `gitpod.io/#https://github.com/YOUR_USER_NAME/freeCodeCamp.git` and you should see a workspace created for you. This works for any repository or pull-request on GitHub.
|
||||
|
||||
<br>
|
||||
<img src="https://raw.githubusercontent.com/freeCodeCamp/freeCodeCamp/main/docs/images/github/how-to-fork-freeCodeCamp.gif" alt="Como criar um fork do freeCodeCamp no GitHub" />
|
||||
</details>
|
||||
|
||||
## Usar uma máquina local ou o GitPod
|
||||
|
||||
Após ter realizado o fork do repositório, você pode usar seu próprio computador local ou um espaço de trabalho baseado no GitPod para trabalhar no código.
|
||||
|
||||
Para contribuir a longo prazo, recomendamos que você instale o freeCodeCamp em seu computador.
|
||||
|
||||
### Como preparar um espaço de trabalho no GitPod
|
||||
|
||||
Nós automatizamos o processo de instalação de todas as dependências e ferramentas de que você precisará. Com o GitPod, você terá um ambiente gratuito e pronto para o código em alguns minutos. Isso é útil caso você não tenha acesso a um computador ou queira fazer alterações únicas.
|
||||
|
||||
Existem várias maneiras de se abrir um espaço de trabalho no GitPod:
|
||||
|
||||
1. **(Mais rápida)** Anexe `gitpod.io/#` na frente de qualquer URL do GitHub.
|
||||
|
||||
Por exemplo, se você for visitar o seu fork em `https://github.com/YOUR_USER_NAME/freeCodeCamp.git`, adicione `gitpod.io/#` na frente do URL na barra de endereços e clique em enter.
|
||||
|
||||
Isso significa que você pode navegar para `gitpod.io/#https://github.com/YOUR_USER_NAME/freeCodeCamp.git` e você verá uma área de trabalho criada para você. Isso funciona para qualquer repositório ou pull request no GitHub.
|
||||
|
||||
2. Como alternativa, instale uma das extensões abaixo para o seu navegador.
|
||||
2. Alternatively install one of the below extensions for your browser.
|
||||
|
||||
- [Chrome Webstore](https://chrome.google.com/webstore/detail/gitpod-always-ready-to-co/dodmmooeoklaejobgleioelladacbeki) - trabalha com navegadores baseados no Chromium, como o Google Chrome, o Brave, o Edge etc.
|
||||
- [Firefox Add-on](https://addons.mozilla.org/en-US/firefox/addon/gitpod) - Firefox
|
||||
|
||||
Uma vez instalado, você verá um botão 'GitPod' em cada repositório, pull request etc. Ele será um atalho útil para abrir um espaço de trabalho a partir de lá. Veja a página da extensão para detalhes, capturas de tela etc.
|
||||
|
||||
É isso. Agora, você pode pular para a seção 'sincronizando a partir do pai' depois de ter iniciado um espaço de trabalho no GitPod. A maior parte deste guia se aplica a espaços de trabalho no GitPod, mas preste atenção em [como funcionam os URLs e as portas em um espaço de trabalho do GitPod](https://www.gitpod.io/docs/configure/workspaces/ports).
|
||||
That's it, you can now skip to the 'syncing up from parent' section after you have launched a GitPod workspace. Most parts of this guide applies to GitPod workspaces, but be mindful of [how the URLs & Ports work within a GitPod](https://www.gitpod.io/docs/configure/workspaces/ports) workspace.
|
||||
|
||||
### Como preparar sua máquina local
|
||||
|
||||
Comece instalando o software pré-requisito para seu sistema operacional.
|
||||
Here is a minimum system requirement for running freeCodeCamp locally:
|
||||
|
||||
Apoiamos principalmente o desenvolvimento em sistemas Linux e Unix. Nossa equipe e colaboradores da comunidade trabalham regularmente com a base de código usando ferramentas instaladas no Ubuntu e no macOS.
|
||||
- 8 GB RAM
|
||||
- Relatively fast CPU (4+ cores)
|
||||
- Windows 10 or 11 (with WSL), macOS, or Linux
|
||||
|
||||
Também suportamos o Windows 10 e 11 via WSL2, que você pode preparar [lendo este guia](how-to-setup-wsl.md).
|
||||
Start by installing the prerequisite software for your operating system.
|
||||
|
||||
We primarily support development on Linux and Unix-based systems like Ubuntu and macOS. You can develop on Windows 10 or 11 with WSL2 only. You can follow [this guide](how-to-setup-wsl.md) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.
|
||||
|
||||
Alguns membros da comunidade também desenvolvem no Windows nativamente com o Git para Windows (Git Bash) e outras ferramentas instaladas no Windows. Neste momento, não dispomos de apoio oficial para esse tipo de instalações, recomendamos que se utilize WSL2.
|
||||
|
||||
#### Pré-requisitos:
|
||||
|
||||
| Pré-requisito | Versão | Observações |
|
||||
| --------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------- |
|
||||
| [Node.js](http://nodejs.org) | `18.x` | Usamos a versão "Active LTS". Consulte [Agenda LTS](https://nodejs.org/en/about/releases/). |
|
||||
| [pnpm](https://pnpm.io/installation) | `8.x` | - |
|
||||
| [Servidor da Comunidade MongoDB](https://docs.mongodb.com/manual/administration/install-community/) | `4.2.x` | - |
|
||||
| Prerequisite | Version | Notes |
|
||||
| --------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------- |
|
||||
| [Node.js](http://nodejs.org) | `18.x` | We use the "Active LTS" version, See [LTS Schedule](https://nodejs.org/en/about/releases/). |
|
||||
| [pnpm](https://pnpm.io/installation) | `8.x` | - |
|
||||
| [MongoDB Community Server](https://docs.mongodb.com/manual/administration/install-community/) | `4.2.x` | - |
|
||||
|
||||
> [!ATTENTION] Se você tem uma versão diferente, instale a versão recomendada. Só podemos dar suporte a problemas de instalação para versões recomendadas. Veja [solução de problemas](#troubleshooting) para detalhes.
|
||||
> [!ATTENTION] If you have a different version, please install the recommended version. We can only support installation issues for recommended versions. See [troubleshooting](#troubleshooting) for details.
|
||||
|
||||
Se o Node.js já estiver instalado em sua máquina, execute os comandos a seguir para validar as versões:
|
||||
If Node.js is already installed on your machine, run the following commands to validate the versions:
|
||||
|
||||
```console
|
||||
node -v
|
||||
pnpm -v
|
||||
```
|
||||
|
||||
> [!TIP] É altamente recomendável atualizar para o mais atual lançamento estável do software listado acima, também conhecido como Lançamentos de Suporte de Longo Prazo (LTS).
|
||||
> [!TIP] We highly recommend updating to the latest stable releases of the software listed above, also known as Long Term Support (LTS) releases.
|
||||
|
||||
Depois de ter os pré-requisitos instalados, você precisa preparar seu ambiente de desenvolvimento. Isto é comum para muitos fluxos de trabalho de desenvolvimento, e você só precisará fazer isso uma vez.
|
||||
Once you have the prerequisites installed, you need to prepare your development environment. This is common for many development workflows, and you will only need to do this once.
|
||||
|
||||
##### Siga estas etapas para deixar seu ambiente de desenvolvimento pronto:
|
||||
|
||||
1. Instale o [Git](https://git-scm.com/) ou seu cliente Git favorito, se você ainda não fez isso. Atualize para a versão mais recente. A versão que veio com seu SO pode estar desatualizada.
|
||||
1. Install [Git](https://git-scm.com/) or your favorite Git client, if you haven't already. Update to the latest version; the version that came bundled with your OS may be outdated.
|
||||
|
||||
2. (Opcional, mas recomendado) [Configure uma chave SSH](https://help.github.com/articles/generating-an-ssh-key/) para o GitHub.
|
||||
2. (Optional but recommended) [Set up an SSH Key](https://help.github.com/articles/generating-an-ssh-key/) for GitHub.
|
||||
|
||||
3. Instale um editor de código de sua escolha.
|
||||
3. Install a code editor of your choice.
|
||||
|
||||
Nós recomendamos muito usar o [Visual Studio Code](https://code.visualstudio.com/) ou o [Atom](https://atom.io/). São ótimos editores gratuitos de código aberto.
|
||||
We highly recommend using [Visual Studio Code](https://code.visualstudio.com/) or [Atom](https://atom.io/). These are great, free and open source code editors.
|
||||
|
||||
4. Configure um linting no seu editor de código.
|
||||
4. Set up linting for your code editor.
|
||||
|
||||
Você deve ter o [ESLint executando no seu editor](http://eslint.org/docs/user-guide/integrations.html), e ele vai destacar qualquer coisa que não esteja em conformidade com o [Guia de estilo JavaScript do freeCodeCamp](http://forum.freecodecamp.org/t/free-code-camp-javascript-style-guide/19121).
|
||||
You should have [ESLint running in your editor](http://eslint.org/docs/user-guide/integrations.html), and it will highlight anything that doesn't conform to [freeCodeCamp's JavaScript Style Guide](http://forum.freecodecamp.org/t/free-code-camp-javascript-style-guide/19121).
|
||||
|
||||
> [!TIP] Não ignore nenhum erro de linting. Eles têm como objetivo **ajudar** você e garantir uma base de código simples e limpa.
|
||||
> [!TIP] Please do not ignore any linting errors. They are meant to **help** you and to ensure a clean and simple codebase.
|
||||
|
||||
## Fork the repository on GitHub
|
||||
|
||||
[Forking](https://help.github.com/articles/about-forks/) is a step where you get your own copy of freeCodeCamp's main repository (a.k.a _repo_) on GitHub.
|
||||
|
||||
This is essential, as it allows you to work on your own copy of freeCodeCamp on GitHub, or to download (clone) your repository to work on locally. Later, you will be able to request changes to be pulled into the main repository from your fork via a pull request (PR).
|
||||
|
||||
> [!TIP] The main repository at `https://github.com/freeCodeCamp/freeCodeCamp` is often referred to as the `upstream` repository.
|
||||
>
|
||||
> Your fork at `https://github.com/YOUR_USER_NAME/freeCodeCamp` is often referred to as the `origin` repository. `YOUR_USER_NAME` would be replaced with your GitHub username.
|
||||
|
||||
**Follow these steps to fork the `https://github.com/freeCodeCamp/freeCodeCamp` repository:**
|
||||
|
||||
1. Go to the freeCodeCamp repository on GitHub: <https://github.com/freeCodeCamp/freeCodeCamp>
|
||||
|
||||
2. Click the "Fork" Button in the upper right-hand corner of the interface ([More Details Here](https://help.github.com/articles/fork-a-repo/))
|
||||
|
||||
3. After the repository has been forked, you will be taken to your copy of the freeCodeCamp repository at `https://github.com/YOUR_USER_NAME/freeCodeCamp` (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
How to fork freeCodeCamp on GitHub (screenshot)
|
||||
</summary>
|
||||
|
||||
<br>
|
||||
<img src="https://raw.githubusercontent.com/freeCodeCamp/freeCodeCamp/main/docs/images/github/how-to-fork-freeCodeCamp.gif" alt="How to fork freeCodeCamp on GitHub" />
|
||||
</details>
|
||||
|
||||
## Clonar o seu fork no GitHub
|
||||
|
||||
[Clonar](https://help.github.com/articles/cloning-a-repository/) é ** a ação de fazer o download de uma cópia** de um repositório de um local `remote` que pertence a você ou a outra pessoa. No seu caso, este local remoto é o seu `fork` do repositório freeCodeCamp que deve estar disponível em `https://github.com/YOUR_USER_NAME/freeCodeCamp`. (`YOUR_USER_NAME` será substituído pelo seu nome de usuário do 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`. (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
|
||||
> [!WARNING] Se você está usando uma distribuição WSL2 Linux, você talvez tenha problemas relacionados a performance e estabilidade ao executar esse projeto em uma pasta compartilhada entre Windows e WSL2 (ex. `/mnt/c/Users/`). Recomendarmos clonar esse repositório em uma pasta que é principalmente usada pela sua distribuição WSL2 Linux e não diretamente compartilhada com Windows (ex. `~/PROJECTS/`).
|
||||
>
|
||||
> Veja [essa issue no GitHub](https://github.com/freeCodeCamp/freeCodeCamp/issues/40632) para mais informações sobre esse problema.
|
||||
|
||||
Execute esses comandos em sua máquina local:
|
||||
Run these commands on your local machine:
|
||||
|
||||
1. Abra um Terminal/Prompt de Comando/Shell no diretório de seus projetos
|
||||
|
||||
@@ -127,17 +135,17 @@ Execute esses comandos em sua máquina local:
|
||||
git clone --depth=1 https://github.com/YOUR_USER_NAME/freeCodeCamp.git
|
||||
```
|
||||
|
||||
Isto vai baixar todo o repositório do freeCodeCamp para seu diretório de projetos.
|
||||
This will download the entire freeCodeCamp repository to your projects directory.
|
||||
|
||||
Nota: `--depth=1` cria um clone raso do seu fork, com apenas o histórico mais recente.
|
||||
Note: `--depth=1` creates a shallow clone of your fork, with only the most recent history/commit.
|
||||
|
||||
## Configurar sincronização a partir do pai
|
||||
|
||||
Agora que você baixou uma cópia do seu fork, será necessário configurar um remote `upstream` para o repositório pai.
|
||||
Now that you have downloaded a copy of your fork, you will need to set up an `upstream` remote to the parent repository.
|
||||
|
||||
[Como mencionado anteriormente](#fork-the-repository-on-github), o repositório principal é referenciado como repositório `upstream`. Seu fork é referenciado como repositório `origin`.
|
||||
[As mentioned earlier](#fork-the-repository-on-github), the main repository is referred `upstream` repository. Your fork referred to as the `origin` repository.
|
||||
|
||||
É necessária uma referência do seu clone local para o repositório `upstream` além do repositório `origin`. Isso é para que você possa sincronizar alterações do repositório principal sem a exigência de fazer fork e clone várias vezes.
|
||||
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. Mude o diretório para o novo diretório freeCodeCamp:
|
||||
|
||||
@@ -168,21 +176,21 @@ Agora que você baixou uma cópia do seu fork, será necessário configurar um r
|
||||
|
||||
## Executando freeCodeCamp localmente
|
||||
|
||||
Agora que você tem uma cópia local do freeCodeCamp, você pode seguir estas instruções para executá-lo localmente. Isso permitirá que você:
|
||||
Now that you have a local copy of freeCodeCamp, you can follow these instructions to run it locally. This will allow you to:
|
||||
|
||||
- Pré-visualize edições das páginas como aparecerão na plataforma de aprendizagem.
|
||||
- Ajude nos problemas relacionados a Interface do Usuário e melhoramentos.
|
||||
- Faça a depuração e corrija problemas com aplicativos de servidor e cliente.
|
||||
- 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.
|
||||
|
||||
Se você encontrar problemas, primeiro faça uma busca na web e procurar por respostas. Se não for encontrada uma solução, procure em nossa página de [issues do GitHub](https://github.com/freeCodeCamp/freeCodeCamp/issues) para encontrar uma solução e reporte o problema se ainda não foi reportado.
|
||||
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.
|
||||
|
||||
E como sempre, fique à vontade em perguntar na [categoria 'Contributors' (colaboradores) do fórum](https://forum.freecodecamp.org/c/contributors) ou [no servidor de chat](https://discord.gg/PRyKn3Vbay).
|
||||
And as always, feel free to ask questions on the ['Contributors' category on our forum](https://forum.freecodecamp.org/c/contributors) or [our chat server](https://discord.gg/PRyKn3Vbay).
|
||||
|
||||
### Configurar dependências
|
||||
|
||||
#### Etapa 1: Configure o arquivo de variável de ambiente
|
||||
|
||||
As chaves de API padrão e variáveis de ambiente são armazenadas no arquivo `sample.env`. Esse arquivo precisa ser copiado para um novo arquivo chamado `.env` que é acessado dinamicamente durante a etapa de instalação.
|
||||
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
|
||||
# Crie uma cópia da "sample.env" e a nomeie como ".env".
|
||||
@@ -205,13 +213,13 @@ copy sample.env .env
|
||||
|
||||
<!-- tabs:end -->
|
||||
|
||||
As chaves no arquivo `.env` _ não _ precisam ser alteradas para executar o aplicativo localmente. Você pode deixar os valores padrão copiados de `sample.env` como estão.
|
||||
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] Lembre-se: se quiser usar serviços como Auth0 ou Algolia, você terá que adquirir suas próprias chaves da API para estes serviços e editar as entradas no arquivo `.env`.
|
||||
|
||||
#### Etapa 2: Instalar as dependências
|
||||
|
||||
Esta etapa vai instalar as dependências necessárias para a execução do aplicativo:
|
||||
This step will install the dependencies required for the application to run:
|
||||
|
||||
```console
|
||||
pnpm install
|
||||
@@ -219,13 +227,13 @@ pnpm install
|
||||
|
||||
#### Etapa 3: Iniciar o MongoDB e criar o banco de dados
|
||||
|
||||
Antes de executar o aplicativo localmente, você precisará iniciar o serviço MongoDB.
|
||||
Before you can run the application locally, you will need to start the MongoDB service.
|
||||
|
||||
> [!NOTE] A menos que você tenha o MongoDB executando em uma configuração diferente da padrão, a URL armazenada como valor para `MONGOHQ_URL` no arquivo `.env` funcionará. Se você está usando uma configuração diferente, modifique este valor caso necessário.
|
||||
>
|
||||
> Se você seguiu as instruções de [Windows 10 via WSL2 Setup Guide](how-to-setup-wsl.md), será capaz de pular este passo se o servidor do MongoDB daquele guia já estiver em execução. Você pode confirmar isso verificando se pode acessar `http://localhost:27017` em seu computador local.
|
||||
|
||||
Inicie o servidor do MongoDB em um terminal separado:
|
||||
Start the MongoDB server in a separate terminal:
|
||||
|
||||
<!-- tabs:start -->
|
||||
|
||||
@@ -237,19 +245,19 @@ mongod
|
||||
|
||||
#### **Windows**
|
||||
|
||||
- No Windows, você deve especificar o caminho completo para o binário do `mongod`
|
||||
- On Windows, you must specify the full path to the `mongod` binary
|
||||
|
||||
```console
|
||||
"C:\Arquivos de programa\MongoDB\Server\3.6\bin\mongod"
|
||||
```
|
||||
|
||||
Certifique-se de substituir `3.6` pela versão que você instalou
|
||||
Make sure to replace `3.6` with the version you have installed
|
||||
|
||||
<!-- tabs:end -->
|
||||
|
||||
> [!TIP] Você pode evitar ter que executar o MongoDB toda vez instalando-o como um serviço em segundo plano. Você pode [aprender mais sobre isso na documentação para seu OS](https://docs.mongodb.com/manual/administration/install-community/)
|
||||
|
||||
Em seguida, vamos criar o banco de dados. Nesta etapa, executamos o comando abaixo que preenche o servidor MongoDB com alguns conjuntos de dados iniciais que são requeridos pelos serviços. Dentre outras coisas, incluem alguns esquemas.
|
||||
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
|
||||
pnpm run seed
|
||||
@@ -257,31 +265,31 @@ pnpm run seed
|
||||
|
||||
#### Etapa 4: Iniciar o aplicativo client do freeCodeCamp e o servidor de API
|
||||
|
||||
Agora você pode iniciar o servidor de API e os aplicativos do client.
|
||||
You can now start up the API server and the client applications.
|
||||
|
||||
```console
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
Este único comando vai disparar todos os serviços, incluindo o servidor API e os aplicativos do cliente disponíveis para você trabalhar.
|
||||
This single command will fire up all the services, including the API server and the client applications available for you to work on.
|
||||
|
||||
Uma vez pronto, abra um navegador e **acesse <http://localhost:8000>**. Se o aplicativo carregar, faça o login. Parabéns – está tudo pronto! Agora você tem uma cópia da plataforma do freeCodeCamp de aprendizagem inteira rodando em sua máquina local.
|
||||
Once ready, open a web browser and **visit <http://localhost:8000>**. If the app loads, sign in. Congratulations – you're all set! You now have a copy of freeCodeCamp's entire learning platform running on your local machine.
|
||||
|
||||
A API serve os endpoints em `http://localhost:3000`. O aplicativo Gatsby atende o aplicativo cliente em `http://localhost:8000`
|
||||
The API serves endpoints at `http://localhost:3000`. The Gatsby app serves the client application at `http://localhost:8000`
|
||||
|
||||
Quando estiver conectado, se você visitar <http://localhost:3000/explorer> poderá ver as APIs disponíveis.
|
||||
While you are logged in, if you visit <http://localhost:3000/explorer> you should see the available APIs.
|
||||
|
||||
> [!WARNING] Limpar seus cookies ou executar `pnpm run seed:certified-user` desconectará você e será preciso fazer o login novamente.
|
||||
|
||||
Se você tiver problemas durante a instalação, confira a [seção de solução de problemas](troubleshooting-development-issues.md)
|
||||
If you have issues while installing it, check out the [troubleshooting section](troubleshooting-development-issues.md)
|
||||
|
||||
## Referência de comandos rápidos
|
||||
|
||||
Uma rápida referência aos comandos que você precisará ao trabalhar localmente.
|
||||
A quick reference to the commands that you will need when working locally.
|
||||
|
||||
| comando | descrição |
|
||||
| ------------------ | ------------------------------------------------------------------------------ |
|
||||
| `pnpm install` | Instala / reinstala todas as dependências e inicializa os diferentes serviços. |
|
||||
| `pnpm run seed` | Cria usuários de testes autorizados e os insere no mongodb. |
|
||||
| `pnpm run develop` | Inicia o servidor de API freeCodeCamp e aplicativos Cliente. |
|
||||
| `pnpm run clean` | Desinstala todas as dependências e limpa os caches. |
|
||||
| command | description |
|
||||
| ------------------ | ----------------------------------------------------------------------------- |
|
||||
| `pnpm install` | Installs / re-install all dependencies and bootstraps the different services. |
|
||||
| `pnpm run seed` | Creates authorized test users and inserts them into mongodb. |
|
||||
| `pnpm run develop` | Starts the freeCodeCamp API Server and Client Applications. |
|
||||
| `pnpm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
|
||||
@@ -1,45 +1,23 @@
|
||||
Follow these guidelines for setting up freeCodeCamp locally on your system. This is highly recommended if you want to contribute regularly.
|
||||
Follow these guidelines for setting up a development environment for freeCodeCamp. This is highly recommended if you want to contribute regularly.
|
||||
|
||||
Some of these contribution workflows – like fixing bugs in the codebase or curriculum – need you to run freeCodeCamp locally on your computer.
|
||||
## Choose between Gitpod or your own machine (local setup)
|
||||
|
||||
> [!TIP] If you are not interested in setting up freeCodeCamp locally, consider using Gitpod. We have automated the process of installing all the dependencies & tools you will need.
|
||||
>
|
||||
> Continue reading this guide to learn more about using GitPod.
|
||||
If you are looking to make a one-off contribution, you should use Gitpod to make changes. The Gitpod setup launches a ready-to-code environment in a few minutes in your web browser. For contributing long-term, we recommend you setup freeCodeCamp on your local machine.
|
||||
|
||||
## Fork the repository on GitHub
|
||||
Here are some pros and cons which should help you decide which option is best for you:
|
||||
|
||||
[Forking](https://help.github.com/articles/about-forks/) is a step where you get your own copy of freeCodeCamp's main repository (a.k.a _repo_) on GitHub.
|
||||
| Gitpod | Your own machine (local setup) |
|
||||
| ----------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| No minimum hardware requirements | Specific and minimum requirements |
|
||||
| No need to install any software | Additional software required |
|
||||
| Always up to date copy of repository | Need to maintain a local copy of the repository |
|
||||
| Slower and can take a few minutes to launch | Faster and can be launched in seconds |
|
||||
| Need an internet connection to work | Minimal internet connection required (once setup) |
|
||||
| Some tasks like compilation and tests can take longer to complete | Faster completion of tasks (depending on your machine's capabilities) |
|
||||
|
||||
This is essential, as it allows you to work on your own copy of freeCodeCamp on GitHub, or to download (clone) your repository to work on locally. Later, you will be able to request changes to be pulled into the main repository from your fork via a pull request (PR).
|
||||
> [!ATTENTION] **Note:** If you are using Windows 10 or 11, you will need to use WSL2. You can follow [this guide](how-to-setup-wsl.md) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.
|
||||
|
||||
> [!TIP] The main repository at `https://github.com/freeCodeCamp/freeCodeCamp` is often referred to as the `upstream` repository.
|
||||
>
|
||||
> Your fork at `https://github.com/YOUR_USER_NAME/freeCodeCamp` is often referred to as the `origin` repository. `YOUR_USER_NAME` would be replaced with your GitHub username.
|
||||
|
||||
**Follow these steps to fork the `https://github.com/freeCodeCamp/freeCodeCamp` repository:**
|
||||
|
||||
1. Go to the freeCodeCamp repository on GitHub: <https://github.com/freeCodeCamp/freeCodeCamp>
|
||||
|
||||
2. Click the "Fork" Button in the upper right-hand corner of the interface ([More Details Here](https://help.github.com/articles/fork-a-repo/))
|
||||
|
||||
3. After the repository has been forked, you will be taken to your copy of the freeCodeCamp repository at `https://github.com/YOUR_USER_NAME/freeCodeCamp` (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
How to fork freeCodeCamp on GitHub (screenshot)
|
||||
</summary>
|
||||
|
||||
<br>
|
||||
<img src="https://raw.githubusercontent.com/freeCodeCamp/freeCodeCamp/main/docs/images/github/how-to-fork-freeCodeCamp.gif" alt="How to fork freeCodeCamp on GitHub" />
|
||||
</details>
|
||||
|
||||
## Use a Local Machine or GitPod
|
||||
|
||||
Once you have forked the repository, you can either use your own local machine or a GitPod-based workspace to work on the codebase.
|
||||
|
||||
For contributing long-term, we recommend you setup freeCodeCamp on your local machine.
|
||||
|
||||
### How to prepare a GitPod workspace
|
||||
### How to prepare a Gitpod workspace
|
||||
|
||||
We have automated the process of installing all the dependencies & tools you will need. With GitPod you get a free ready-to-code environment in a few minutes, and is useful if you do not have access to computer or want to make one-time changes.
|
||||
|
||||
@@ -62,13 +40,16 @@ That's it, you can now skip to the 'syncing up from parent' section after you ha
|
||||
|
||||
### How to prepare your local machine
|
||||
|
||||
Here is a minimum system requirement for running freeCodeCamp locally:
|
||||
|
||||
- 8 GB RAM
|
||||
- Relatively fast CPU (4+ cores)
|
||||
- Windows 10 or 11 (with WSL), macOS, or Linux
|
||||
|
||||
Start by installing the prerequisite software for your operating system.
|
||||
|
||||
We primarily support development on Linux and Unix-based systems. Our staff and community contributors regularly work with the codebase using tools installed on Ubuntu and macOS.
|
||||
We primarily support development on Linux and Unix-based systems like Ubuntu and macOS. You can develop on Windows 10 or 11 with WSL2 only. You can follow [this guide](how-to-setup-wsl.md) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.
|
||||
|
||||
We also support Windows 10 and 11 via WSL2, which you can prepare by [reading this guide](how-to-setup-wsl.md).
|
||||
|
||||
Some community members also develop on Windows natively with Git for Windows (Git Bash), and other tools installed on Windows. We do not have official support for such a setup at this time, we recommend using WSL2 instead.
|
||||
|
||||
#### Prerequisites:
|
||||
|
||||
@@ -107,6 +88,33 @@ Once you have the prerequisites installed, you need to prepare your development
|
||||
|
||||
> [!TIP] Please do not ignore any linting errors. They are meant to **help** you and to ensure a clean and simple codebase.
|
||||
|
||||
## Fork the repository on GitHub
|
||||
|
||||
[Forking](https://help.github.com/articles/about-forks/) is a step where you get your own copy of freeCodeCamp's main repository (a.k.a _repo_) on GitHub.
|
||||
|
||||
This is essential, as it allows you to work on your own copy of freeCodeCamp on GitHub, or to download (clone) your repository to work on locally. Later, you will be able to request changes to be pulled into the main repository from your fork via a pull request (PR).
|
||||
|
||||
> [!TIP] The main repository at `https://github.com/freeCodeCamp/freeCodeCamp` is often referred to as the `upstream` repository.
|
||||
>
|
||||
> Your fork at `https://github.com/YOUR_USER_NAME/freeCodeCamp` is often referred to as the `origin` repository. `YOUR_USER_NAME` would be replaced with your GitHub username.
|
||||
|
||||
**Follow these steps to fork the `https://github.com/freeCodeCamp/freeCodeCamp` repository:**
|
||||
|
||||
1. Go to the freeCodeCamp repository on GitHub: <https://github.com/freeCodeCamp/freeCodeCamp>
|
||||
|
||||
2. Click the "Fork" Button in the upper right-hand corner of the interface ([More Details Here](https://help.github.com/articles/fork-a-repo/))
|
||||
|
||||
3. After the repository has been forked, you will be taken to your copy of the freeCodeCamp repository at `https://github.com/YOUR_USER_NAME/freeCodeCamp` (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
How to fork freeCodeCamp on GitHub (screenshot)
|
||||
</summary>
|
||||
|
||||
<br>
|
||||
<img src="https://raw.githubusercontent.com/freeCodeCamp/freeCodeCamp/main/docs/images/github/how-to-fork-freeCodeCamp.gif" alt="How to fork freeCodeCamp on GitHub" />
|
||||
</details>
|
||||
|
||||
## 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`. (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
@@ -176,7 +184,7 @@ Now that you have a local copy of freeCodeCamp, you can follow these instruction
|
||||
|
||||
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.
|
||||
|
||||
І як завжди, не соромтесь ставити запитання [на форумі у категорії «Contributors»](https://forum.freecodecamp.org/c/contributors) або [у чаті](https://discord.gg/PRyKn3Vbay).
|
||||
And as always, feel free to ask questions on the ['Contributors' category on our forum](https://forum.freecodecamp.org/c/contributors) or [our chat server](https://discord.gg/PRyKn3Vbay).
|
||||
|
||||
### Configuring dependencies
|
||||
|
||||
|
||||
Reference in New Issue
Block a user