mirror of
https://github.com/freeCodeCamp/freeCodeCamp.git
synced 2026-01-07 00:03:44 -05:00
chore(i18n,docs): processed translations (#49572)
This commit is contained in:
@@ -91,7 +91,7 @@ Currently, only members on the developer team can push to the production branche
|
||||
4. Confirm that you are able to build the repository locally.
|
||||
|
||||
```
|
||||
npm run clean-and-develop
|
||||
pnpm run clean-and-develop
|
||||
```
|
||||
|
||||
5. Move changes from `main` to `prod-staging` via a fast-forward merge
|
||||
@@ -453,13 +453,13 @@ Provisioning VMs with the Code
|
||||
6. Install dependencies
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
7. Build the server
|
||||
|
||||
```console
|
||||
npm run prebuild && npm run build:curriculum && npm run build:server
|
||||
pnpm run prebuild && pnpm run build:curriculum && pnpm run build:server
|
||||
```
|
||||
|
||||
8. Start Instances
|
||||
@@ -496,13 +496,13 @@ pm2 stop all
|
||||
2. Install dependencies
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
3. Build the server
|
||||
|
||||
```console
|
||||
npm run create:config && npm run build:curriculum && npm run build:server
|
||||
pnpm run create:config && pnpm run build:curriculum && pnpm run build:server
|
||||
```
|
||||
|
||||
4. Start Instances
|
||||
@@ -788,8 +788,8 @@ ssh into the VM (hosted on Digital Ocean).
|
||||
```console
|
||||
cd tools
|
||||
git pull origin master
|
||||
npm ci
|
||||
npm run build
|
||||
pnpm install
|
||||
pnpm run build
|
||||
pm2 restart contribute-app
|
||||
```
|
||||
|
||||
|
||||
@@ -27,25 +27,25 @@ To run tests against production builds, replace `dev` with `prd` below.
|
||||
- To run all tests in the `./cypress` directory:
|
||||
|
||||
```console
|
||||
npm run cypress:dev:run
|
||||
pnpm run cypress:dev:run
|
||||
```
|
||||
|
||||
- To run a single test:
|
||||
|
||||
```console
|
||||
npm run cypress -- run --spec=cypress/<path_to_test_file>
|
||||
pnpm run cypress -- run --spec=cypress/<path_to_test_file>
|
||||
```
|
||||
|
||||
For example:
|
||||
|
||||
```console
|
||||
npm run cypress -- run --spec=cypress/e2e/default/landing.js
|
||||
pnpm run cypress -- run --spec=cypress/e2e/default/landing.js
|
||||
```
|
||||
|
||||
- To create a development build, start the development server, and run all existing cypress end-to-end tests:
|
||||
|
||||
```console
|
||||
npm run e2e:dev:run
|
||||
pnpm run e2e:dev:run
|
||||
```
|
||||
|
||||
## Cypress-GitPod Setup
|
||||
@@ -63,19 +63,19 @@ mongod
|
||||
- Seed the database
|
||||
|
||||
```console
|
||||
npm run seed
|
||||
pnpm run seed
|
||||
```
|
||||
|
||||
- Develop the server and client
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
### 2. Install Cypress Build Tools
|
||||
|
||||
```console
|
||||
npm run cypress:install-build-tools
|
||||
pnpm run cypress:install-build-tools
|
||||
```
|
||||
|
||||
- When prompted in the terminal, select your keyboard layout by language/area
|
||||
|
||||
@@ -201,15 +201,15 @@ After you've committed your changes, check here for [how to open a Pull Request]
|
||||
|
||||
A quick reference to the commands that you will need when working.
|
||||
|
||||
| command | description |
|
||||
| -------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `npm test` | Run all JS tests in the system, including client, server, lint and challenge tests. |
|
||||
| `npm run test-client` | Run the client test suite. |
|
||||
| `npm run test:curriculum` | Run the curriculum test suite. |
|
||||
| `npm run test:curriculum --block='Basic HTML and HTML5'` | Test a specific Block. |
|
||||
| `npm run test:curriculum --superblock='responsive-web-design'` | Test a specific SuperBlock. |
|
||||
| `npm run test-curriculum-full-output` | Run the curriculum test suite, without bailing after the first error |
|
||||
| `npm run test-server` | Run the server test suite. |
|
||||
| `npm run e2e` | Run the Cypress end to end tests. |
|
||||
| `npm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
| `npm run storybook` | Starts Storybook for component library development. |
|
||||
| command | description |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `pnpm test` | Run all JS tests in the system, including client, server, lint and challenge tests. |
|
||||
| `pnpm run test-client` | Run the client test suite. |
|
||||
| `pnpm run test:curriculum` | Run the curriculum test suite. |
|
||||
| `FCC_BLOCK='Basic HTML and HTML5' pnpm run test:curriculum` | Test a specific Block. |
|
||||
| `FCC_SUPERBLOCK='responsive-web-design' pnpm run test:curriculum` | Test a specific SuperBlock. |
|
||||
| `pnpm run test-curriculum-full-output` | Run the curriculum test suite, without bailing after the first error |
|
||||
| `pnpm run test-server` | Run the server test suite. |
|
||||
| `pnpm run e2e` | Run the Cypress end to end tests. |
|
||||
| `pnpm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
| `pnpm run storybook` | Starts Storybook for component library development. |
|
||||
|
||||
@@ -293,9 +293,9 @@ Once you have the files, you will need to place them in the correct directory. F
|
||||
|
||||
Update your `.env` file to use your new language for `CLIENT_LOCALE` and `CURRICULUM_LOCALE`.
|
||||
|
||||
Once these are in place, you should be able to run `npm run develop` to view your translated version of freeCodeCamp.
|
||||
Once these are in place, you should be able to run `pnpm run develop` to view your translated version of freeCodeCamp.
|
||||
|
||||
> [!TIP] If you build the client in one language and then want to build it in a different language, you will need to use the command `npm run clean-and-develop` after changing the `.env` file, as Gatsby will cache the first language.
|
||||
> [!TIP] If you build the client in one language and then want to build it in a different language, you will need to use the command `pnpm run clean-and-develop` after changing the `.env` file, as Gatsby will cache the first language.
|
||||
|
||||
> [!ATTENTION] While you may perform translations locally for the purpose of testing, we remind everyone that translations should _not_ be submitted through GitHub and should only be done through Crowdin. Be sure to reset your local codebase after you are done testing.
|
||||
|
||||
|
||||
@@ -188,14 +188,14 @@ When you are working on features for our upcoming curriculum `next-*` branches,
|
||||
4. Resolve any conflicts, cleanup, install dependencies and run tests
|
||||
|
||||
```console
|
||||
npm run clean
|
||||
pnpm run clean
|
||||
|
||||
npm ci
|
||||
npm run test:curriculum --superblock=<superblock-name>
|
||||
pnpm install
|
||||
FCC_SUPERBLOCK='<superblock-name>' pnpm run test:curriculum
|
||||
|
||||
# example:
|
||||
|
||||
# npm run test:curriculum --superblock=python-for-everybody
|
||||
# FCC_SUPERBLOCK='python-for-everybody' pnpm run test:curriculum
|
||||
|
||||
```
|
||||
|
||||
|
||||
@@ -75,7 +75,7 @@ Some community members also develop on Windows natively with Git for Windows (Gi
|
||||
| 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/). |
|
||||
| npm (comes bundled with Node) | `8.x` | We use the version bundled with Node.js Active LTS. |
|
||||
| [pnpm](https://pnpm.io/installation) | `7.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.
|
||||
@@ -84,7 +84,7 @@ If Node.js is already installed on your machine, run the following commands to v
|
||||
|
||||
```console
|
||||
node -v
|
||||
npm -v
|
||||
pnpm -v
|
||||
```
|
||||
|
||||
> [!TIP] We highly recommend updating to the latest stable releases of the software listed above, also known as Long Term Support (LTS) releases.
|
||||
@@ -214,7 +214,7 @@ The keys in the `.env` file are _not_ required to be changed to run the app loca
|
||||
This step will install the dependencies required for the application to run:
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
#### Step 3: Start MongoDB and seed the database
|
||||
@@ -252,7 +252,7 @@ Make sure to replace `3.6` with the version you have installed
|
||||
Next, let's seed the database. In this step, we run the below command that fills the MongoDB server with some initial data sets that are required by services. These include a few schemas, among other things.
|
||||
|
||||
```console
|
||||
npm run seed
|
||||
pnpm run seed
|
||||
```
|
||||
|
||||
#### Step 4: Start the freeCodeCamp client application and API server
|
||||
@@ -260,7 +260,7 @@ npm run seed
|
||||
You can now start up the API server and the client applications.
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
This single command will fire up all the services, including the API server and the client applications available for you to work on.
|
||||
@@ -271,7 +271,7 @@ The API serves endpoints at `http://localhost:3000`. The Gatsby app serves the c
|
||||
|
||||
While you are logged in, if you visit <http://localhost:3000/explorer> you should see the available APIs.
|
||||
|
||||
> [!WARNING] Clearing your cookies or running `npm run seed:certified-user` will log you out, and you will have to sign in again.
|
||||
> [!WARNING] Clearing your cookies or running `pnpm run seed:certified-user` will log you out, and you will have to sign in again.
|
||||
|
||||
If you have issues while installing it, check out the [troubleshooting section](troubleshooting-development-issues.md)
|
||||
|
||||
@@ -279,9 +279,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.
|
||||
|
||||
| command | description |
|
||||
| ----------------- | ----------------------------------------------------------------------------- |
|
||||
| `npm ci` | Installs / re-install all dependencies and bootstraps the different services. |
|
||||
| `npm run seed` | Creates authorized test users and inserts them into mongodb. |
|
||||
| `npm run develop` | Starts the freeCodeCamp API Server and Client Applications. |
|
||||
| `npm 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. |
|
||||
|
||||
@@ -12,4 +12,4 @@ If you see messages like
|
||||
bash: change_volumes_owner.sh: No such file or directory
|
||||
```
|
||||
|
||||
when you `npm run docker:init` this is likely the culprit.
|
||||
when you `pnpm run docker:init` this is likely the culprit.
|
||||
|
||||
@@ -457,17 +457,17 @@ Before you [create a pull request](how-to-open-a-pull-request.md) for your chang
|
||||
1. To test all challenges run the below command from the root directory
|
||||
|
||||
````
|
||||
npm run test:curriculum
|
||||
pnpm run test:curriculum
|
||||
```
|
||||
|
||||
2. You can also test a block or a superblock of challenges with these commands
|
||||
|
||||
```
|
||||
npm run test:curriculum --block='Basic HTML and HTML5'
|
||||
FCC_BLOCK='Basic HTML and HTML5' pnpm run test:curriculum
|
||||
```
|
||||
|
||||
```
|
||||
npm run test:curriculum --superblock=responsive-web-design
|
||||
FCC_SUPERBLOCK='responsive-web-design' pnpm run test:curriculum
|
||||
```
|
||||
|
||||
You are also able to test one challenge individually by performing the following steps:
|
||||
@@ -481,7 +481,7 @@ You are also able to test one challenge individually by performing the following
|
||||
2. Run the following for each challenge file for which you have changed (replacing `challenge-title-goes-here` with the full title of the challenge):
|
||||
|
||||
```
|
||||
npm run test -- -g challenge-title-goes-here ```
|
||||
pnpm run test -- -g challenge-title-goes-here ```
|
||||
|
||||
Once you have verified that each challenge you've worked on passes the tests, [please create a pull request](how-to-open-a-pull-request.md).
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ These instructions will tell you how to use our challenge editor tool to work on
|
||||
|
||||
### Starting the Editor
|
||||
|
||||
To start the editor, make sure you are in the root freecodecamp directory. Then, run `npm run challenge-editor` to start both the client and the API that powers the editor.
|
||||
To start the editor, make sure you are in the root freecodecamp directory. Then, run `pnpm run challenge-editor` to start both the client and the API that powers the editor.
|
||||
|
||||
The client will run on port `3300`, so you can access it at `http://localhost:3300`. The API runs on port `3200`, to avoid conflicts with the learn client and server. This will allow you to run the freeCodeCamp application at the same time as the editor, so you can test your changes locally.
|
||||
|
||||
@@ -60,7 +60,7 @@ The `tools/challenge-helper-scripts` folder contains tools to help facilitate th
|
||||
|
||||
### Create a new project
|
||||
|
||||
Run `npm run create-project` from the root directory. This opens up a command line ui that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/01-responsive-web-design/test-project`.
|
||||
Run `pnpm run create-project` from the root directory. This opens up a command line ui that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/01-responsive-web-design/test-project`.
|
||||
|
||||
If you want to create new steps, the following tools simplify that process.
|
||||
|
||||
@@ -71,10 +71,10 @@ A one-off script that will automatically add the next step based on the last ste
|
||||
#### How to run script:
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run create-next-step
|
||||
pnpm run create-next-step
|
||||
```
|
||||
|
||||
### create-empty-steps
|
||||
@@ -86,10 +86,10 @@ A one-off script that automatically adds a specified number of steps. The challe
|
||||
#### How to run script:
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run create-empty-steps X # where X is the number of steps to create.
|
||||
pnpm run create-empty-steps X # where X is the number of steps to create.
|
||||
```
|
||||
|
||||
### insert-step
|
||||
@@ -101,10 +101,10 @@ A one-off script that automatically adds a new step at a specified position, inc
|
||||
#### How to run script:
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run insert-step X # where X is the position to insert the new step.
|
||||
pnpm run insert-step X # where X is the position to insert the new step.
|
||||
```
|
||||
|
||||
### delete-step
|
||||
@@ -116,10 +116,10 @@ A one-off script that deletes an existing step, decrementing all subsequent step
|
||||
#### How to run script
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run delete-step X # where X is the step number to be deleted.
|
||||
pnpm run delete-step X # where X is the step number to be deleted.
|
||||
```
|
||||
|
||||
### update-step-titles
|
||||
@@ -129,8 +129,8 @@ A one-off script that automatically updates the frontmatter in a project's markd
|
||||
#### How to run script
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run update-step-titles
|
||||
pnpm run update-step-titles
|
||||
```
|
||||
|
||||
@@ -30,7 +30,7 @@ A new component can be created using the following command from the root directo
|
||||
```bash
|
||||
cd tools/ui-components
|
||||
|
||||
npm run gen-component MyComponent
|
||||
pnpm run gen-component MyComponent
|
||||
```
|
||||
|
||||
The command will generate a new folder inside the `ui-components` directory, with the following files:
|
||||
@@ -76,7 +76,7 @@ Use cases of the component should be added to the Storybook file (`.stories.tsx`
|
||||
To start Storybook, run the following command from the root directory:
|
||||
|
||||
```bash
|
||||
npm run storybook
|
||||
pnpm run storybook
|
||||
```
|
||||
|
||||
The Storybook page is available on [http://localhost:6006](http://localhost:6006).
|
||||
@@ -88,7 +88,7 @@ We use [React Testing Library](https://testing-library.com/docs/react-testing-li
|
||||
To run tests against the component library, run the following command from the root directory:
|
||||
|
||||
```bash
|
||||
npm run test-ui-components
|
||||
pnpm run test-ui-components
|
||||
```
|
||||
|
||||
## Adding packages to the UI-Component library
|
||||
@@ -96,7 +96,8 @@ npm run test-ui-components
|
||||
We restrict adding new packages to the UI Components to help with the project's maintainability. In the rare chance that you think a dependency is needed, please check with the maintainers first and then use the following command to add a package:
|
||||
|
||||
```bash
|
||||
npm i -w=tools/ui-components package_name
|
||||
cd tools/ui-components
|
||||
pnpm add package_name
|
||||
```
|
||||
|
||||
### Useful links
|
||||
|
||||
@@ -50,13 +50,13 @@ Install freeCodeCamp locally ([see the local setup guide](how-to-setup-freecodec
|
||||
#### Serve and launch the documentation site only
|
||||
|
||||
```console
|
||||
npm run docs:serve
|
||||
pnpm run docs:serve
|
||||
```
|
||||
|
||||
#### Serve the documentation site alongside freeCodeCamp locally:
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
> The documentation site should be available at <http://localhost:3400>
|
||||
|
||||
@@ -17,10 +17,10 @@ If you are on a different OS or are still facing issues, see [getting help](#get
|
||||
When you build the client, Gatsby will cache the Fonts, language strings and UI. If one of them isn't cached, run the following:
|
||||
|
||||
```console
|
||||
npm run clean
|
||||
npm ci
|
||||
npm run seed
|
||||
npm run develop
|
||||
pnpm run clean
|
||||
pnpm install
|
||||
pnpm run seed
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
OR
|
||||
@@ -28,7 +28,7 @@ OR
|
||||
Use the shortcut
|
||||
|
||||
```
|
||||
npm run clean-and-develop
|
||||
pnpm run clean-and-develop
|
||||
```
|
||||
|
||||
If you continue to face issues with the build, cleaning up the workspace is recommend.
|
||||
@@ -78,7 +78,7 @@ TCP 0.0.0.0:3000 DESKTOP LISTENING
|
||||
|
||||
While in development, your session is stored as cookies. Clearing them will sign you out of your development account.
|
||||
|
||||
Running `npm run seed:certified-user` will log you out, too. It will overwrite the development user in your local database.
|
||||
Running `pnpm run seed:certified-user` will log you out, too. It will overwrite the development user in your local database.
|
||||
|
||||
### Issue getting 404 when navigating profile page
|
||||
|
||||
|
||||
@@ -91,7 +91,7 @@ Currently, only members on the developer team can push to the production branche
|
||||
4. Confirm that you are able to build the repository locally.
|
||||
|
||||
```
|
||||
npm run clean-and-develop
|
||||
pnpm run clean-and-develop
|
||||
```
|
||||
|
||||
5. Move changes from `main` to `prod-staging` via a fast-forward merge
|
||||
@@ -453,13 +453,13 @@ Provisioning VMs with the Code
|
||||
6. Install dependencies
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
7. Build the server
|
||||
|
||||
```console
|
||||
npm run prebuild && npm run build:curriculum && npm run build:server
|
||||
pnpm run prebuild && pnpm run build:curriculum && pnpm run build:server
|
||||
```
|
||||
|
||||
8. Start Instances
|
||||
@@ -496,13 +496,13 @@ pm2 stop all
|
||||
2. Install dependencies
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
3. Build the server
|
||||
|
||||
```console
|
||||
npm run create:config && npm run build:curriculum && npm run build:server
|
||||
pnpm run create:config && pnpm run build:curriculum && pnpm run build:server
|
||||
```
|
||||
|
||||
4. Start Instances
|
||||
@@ -788,8 +788,8 @@ ssh into the VM (hosted on Digital Ocean).
|
||||
```console
|
||||
cd tools
|
||||
git pull origin master
|
||||
npm ci
|
||||
npm run build
|
||||
pnpm install
|
||||
pnpm run build
|
||||
pm2 restart contribute-app
|
||||
```
|
||||
|
||||
|
||||
@@ -27,25 +27,25 @@ To run tests against production builds, replace `dev` with `prd` below.
|
||||
- To run all tests in the `./cypress` directory:
|
||||
|
||||
```console
|
||||
npm run cypress:dev:run
|
||||
pnpm run cypress:dev:run
|
||||
```
|
||||
|
||||
- To run a single test:
|
||||
|
||||
```console
|
||||
npm run cypress -- run --spec=cypress/<path_to_test_file>
|
||||
pnpm run cypress -- run --spec=cypress/<path_to_test_file>
|
||||
```
|
||||
|
||||
For example:
|
||||
|
||||
```console
|
||||
npm run cypress -- run --spec=cypress/e2e/default/landing.js
|
||||
pnpm run cypress -- run --spec=cypress/e2e/default/landing.js
|
||||
```
|
||||
|
||||
- To create a development build, start the development server, and run all existing cypress end-to-end tests:
|
||||
|
||||
```console
|
||||
npm run e2e:dev:run
|
||||
pnpm run e2e:dev:run
|
||||
```
|
||||
|
||||
## Cypress-GitPod Setup
|
||||
@@ -63,19 +63,19 @@ mongod
|
||||
- Seed the database
|
||||
|
||||
```console
|
||||
npm run seed
|
||||
pnpm run seed
|
||||
```
|
||||
|
||||
- Develop the server and client
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
### 2. Install Cypress Build Tools
|
||||
|
||||
```console
|
||||
npm run cypress:install-build-tools
|
||||
pnpm run cypress:install-build-tools
|
||||
```
|
||||
|
||||
- When prompted in the terminal, select your keyboard layout by language/area
|
||||
|
||||
@@ -201,15 +201,15 @@ After you've committed your changes, check here for [how to open a Pull Request]
|
||||
|
||||
A quick reference to the commands that you will need when working.
|
||||
|
||||
| command | description |
|
||||
| -------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `npm test` | Run all JS tests in the system, including client, server, lint and challenge tests. |
|
||||
| `npm run test-client` | Run the client test suite. |
|
||||
| `npm run test:curriculum` | Run the curriculum test suite. |
|
||||
| `npm run test:curriculum --block='Basic HTML and HTML5'` | Test a specific Block. |
|
||||
| `npm run test:curriculum --superblock='responsive-web-design'` | Test a specific SuperBlock. |
|
||||
| `npm run test-curriculum-full-output` | Run the curriculum test suite, without bailing after the first error |
|
||||
| `npm run test-server` | Run the server test suite. |
|
||||
| `npm run e2e` | Run the Cypress end to end tests. |
|
||||
| `npm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
| `npm run storybook` | Starts Storybook for component library development. |
|
||||
| command | description |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `pnpm test` | Run all JS tests in the system, including client, server, lint and challenge tests. |
|
||||
| `pnpm run test-client` | Run the client test suite. |
|
||||
| `pnpm run test:curriculum` | Run the curriculum test suite. |
|
||||
| `FCC_BLOCK='Basic HTML and HTML5' pnpm run test:curriculum` | Test a specific Block. |
|
||||
| `FCC_SUPERBLOCK='responsive-web-design' pnpm run test:curriculum` | Test a specific SuperBlock. |
|
||||
| `pnpm run test-curriculum-full-output` | Run the curriculum test suite, without bailing after the first error |
|
||||
| `pnpm run test-server` | Run the server test suite. |
|
||||
| `pnpm run e2e` | Run the Cypress end to end tests. |
|
||||
| `pnpm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
| `pnpm run storybook` | Starts Storybook for component library development. |
|
||||
|
||||
@@ -293,9 +293,9 @@ Once you have the files, you will need to place them in the correct directory. F
|
||||
|
||||
Update your `.env` file to use your new language for `CLIENT_LOCALE` and `CURRICULUM_LOCALE`.
|
||||
|
||||
Once these are in place, you should be able to run `npm run develop` to view your translated version of freeCodeCamp.
|
||||
Once these are in place, you should be able to run `pnpm run develop` to view your translated version of freeCodeCamp.
|
||||
|
||||
> [!TIP] If you build the client in one language and then want to build it in a different language, you will need to use the command `npm run clean-and-develop` after changing the `.env` file, as Gatsby will cache the first language.
|
||||
> [!TIP] If you build the client in one language and then want to build it in a different language, you will need to use the command `pnpm run clean-and-develop` after changing the `.env` file, as Gatsby will cache the first language.
|
||||
|
||||
> [!ATTENTION] While you may perform translations locally for the purpose of testing, we remind everyone that translations should _not_ be submitted through GitHub and should only be done through Crowdin. Be sure to reset your local codebase after you are done testing.
|
||||
|
||||
|
||||
@@ -188,14 +188,14 @@ When you are working on features for our upcoming curriculum `next-*` branches,
|
||||
4. Resolve any conflicts, cleanup, install dependencies and run tests
|
||||
|
||||
```console
|
||||
npm run clean
|
||||
pnpm run clean
|
||||
|
||||
npm ci
|
||||
npm run test:curriculum --superblock=<superblock-name>
|
||||
pnpm install
|
||||
FCC_SUPERBLOCK='<superblock-name>' pnpm run test:curriculum
|
||||
|
||||
# example:
|
||||
|
||||
# npm run test:curriculum --superblock=python-for-everybody
|
||||
# FCC_SUPERBLOCK='python-for-everybody' pnpm run test:curriculum
|
||||
|
||||
```
|
||||
|
||||
|
||||
@@ -75,7 +75,7 @@ Some community members also develop on Windows natively with Git for Windows (Gi
|
||||
| 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/). |
|
||||
| npm (comes bundled with Node) | `8.x` | We use the version bundled with Node.js Active LTS. |
|
||||
| [pnpm](https://pnpm.io/installation) | `7.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.
|
||||
@@ -84,7 +84,7 @@ If Node.js is already installed on your machine, run the following commands to v
|
||||
|
||||
```console
|
||||
node -v
|
||||
npm -v
|
||||
pnpm -v
|
||||
```
|
||||
|
||||
> [!TIP] We highly recommend updating to the latest stable releases of the software listed above, also known as Long Term Support (LTS) releases.
|
||||
@@ -214,7 +214,7 @@ The keys in the `.env` file are _not_ required to be changed to run the app loca
|
||||
This step will install the dependencies required for the application to run:
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
#### Step 3: Start MongoDB and seed the database
|
||||
@@ -252,7 +252,7 @@ Make sure to replace `3.6` with the version you have installed
|
||||
Next, let's seed the database. In this step, we run the below command that fills the MongoDB server with some initial data sets that are required by services. These include a few schemas, among other things.
|
||||
|
||||
```console
|
||||
npm run seed
|
||||
pnpm run seed
|
||||
```
|
||||
|
||||
#### Step 4: Start the freeCodeCamp client application and API server
|
||||
@@ -260,7 +260,7 @@ npm run seed
|
||||
You can now start up the API server and the client applications.
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
This single command will fire up all the services, including the API server and the client applications available for you to work on.
|
||||
@@ -271,7 +271,7 @@ The API serves endpoints at `http://localhost:3000`. The Gatsby app serves the c
|
||||
|
||||
While you are logged in, if you visit <http://localhost:3000/explorer> you should see the available APIs.
|
||||
|
||||
> [!WARNING] Clearing your cookies or running `npm run seed:certified-user` will log you out, and you will have to sign in again.
|
||||
> [!WARNING] Clearing your cookies or running `pnpm run seed:certified-user` will log you out, and you will have to sign in again.
|
||||
|
||||
If you have issues while installing it, check out the [troubleshooting section](troubleshooting-development-issues.md)
|
||||
|
||||
@@ -279,9 +279,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.
|
||||
|
||||
| command | description |
|
||||
| ----------------- | ----------------------------------------------------------------------------- |
|
||||
| `npm ci` | Installs / re-install all dependencies and bootstraps the different services. |
|
||||
| `npm run seed` | Creates authorized test users and inserts them into mongodb. |
|
||||
| `npm run develop` | Starts the freeCodeCamp API Server and Client Applications. |
|
||||
| `npm 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. |
|
||||
|
||||
@@ -12,4 +12,4 @@ If you see messages like
|
||||
bash: change_volumes_owner.sh: No such file or directory
|
||||
```
|
||||
|
||||
when you `npm run docker:init` this is likely the culprit.
|
||||
when you `pnpm run docker:init` this is likely the culprit.
|
||||
|
||||
@@ -457,17 +457,17 @@ Before you [create a pull request](how-to-open-a-pull-request.md) for your chang
|
||||
1. To test all challenges run the below command from the root directory
|
||||
|
||||
````
|
||||
npm run test:curriculum
|
||||
pnpm run test:curriculum
|
||||
```
|
||||
|
||||
2. You can also test a block or a superblock of challenges with these commands
|
||||
|
||||
```
|
||||
npm run test:curriculum --block='Basic HTML and HTML5'
|
||||
FCC_BLOCK='Basic HTML and HTML5' pnpm run test:curriculum
|
||||
```
|
||||
|
||||
```
|
||||
npm run test:curriculum --superblock=responsive-web-design
|
||||
FCC_SUPERBLOCK='responsive-web-design' pnpm run test:curriculum
|
||||
```
|
||||
|
||||
You are also able to test one challenge individually by performing the following steps:
|
||||
@@ -481,7 +481,7 @@ You are also able to test one challenge individually by performing the following
|
||||
2. Run the following for each challenge file for which you have changed (replacing `challenge-title-goes-here` with the full title of the challenge):
|
||||
|
||||
```
|
||||
npm run test -- -g challenge-title-goes-here ```
|
||||
pnpm run test -- -g challenge-title-goes-here ```
|
||||
|
||||
Once you have verified that each challenge you've worked on passes the tests, [please create a pull request](how-to-open-a-pull-request.md).
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ These instructions will tell you how to use our challenge editor tool to work on
|
||||
|
||||
### Starting the Editor
|
||||
|
||||
To start the editor, make sure you are in the root freecodecamp directory. Then, run `npm run challenge-editor` to start both the client and the API that powers the editor.
|
||||
To start the editor, make sure you are in the root freecodecamp directory. Then, run `pnpm run challenge-editor` to start both the client and the API that powers the editor.
|
||||
|
||||
The client will run on port `3300`, so you can access it at `http://localhost:3300`. The API runs on port `3200`, to avoid conflicts with the learn client and server. This will allow you to run the freeCodeCamp application at the same time as the editor, so you can test your changes locally.
|
||||
|
||||
@@ -60,7 +60,7 @@ The `tools/challenge-helper-scripts` folder contains tools to help facilitate th
|
||||
|
||||
### Create a new project
|
||||
|
||||
Run `npm run create-project` from the root directory. This opens up a command line ui that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/01-responsive-web-design/test-project`.
|
||||
Run `pnpm run create-project` from the root directory. This opens up a command line ui that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/01-responsive-web-design/test-project`.
|
||||
|
||||
If you want to create new steps, the following tools simplify that process.
|
||||
|
||||
@@ -71,10 +71,10 @@ A one-off script that will automatically add the next step based on the last ste
|
||||
#### How to run script:
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run create-next-step
|
||||
pnpm run create-next-step
|
||||
```
|
||||
|
||||
### create-empty-steps
|
||||
@@ -86,10 +86,10 @@ A one-off script that automatically adds a specified number of steps. The challe
|
||||
#### How to run script:
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run create-empty-steps X # where X is the number of steps to create.
|
||||
pnpm run create-empty-steps X # where X is the number of steps to create.
|
||||
```
|
||||
|
||||
### insert-step
|
||||
@@ -101,10 +101,10 @@ A one-off script that automatically adds a new step at a specified position, inc
|
||||
#### How to run script:
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run insert-step X # where X is the position to insert the new step.
|
||||
pnpm run insert-step X # where X is the position to insert the new step.
|
||||
```
|
||||
|
||||
### delete-step
|
||||
@@ -116,10 +116,10 @@ A one-off script that deletes an existing step, decrementing all subsequent step
|
||||
#### How to run script
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run delete-step X # where X is the step number to be deleted.
|
||||
pnpm run delete-step X # where X is the step number to be deleted.
|
||||
```
|
||||
|
||||
### update-step-titles
|
||||
@@ -129,8 +129,8 @@ A one-off script that automatically updates the frontmatter in a project's markd
|
||||
#### How to run script
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run update-step-titles
|
||||
pnpm run update-step-titles
|
||||
```
|
||||
|
||||
@@ -30,7 +30,7 @@ A new component can be created using the following command from the root directo
|
||||
```bash
|
||||
cd tools/ui-components
|
||||
|
||||
npm run gen-component MyComponent
|
||||
pnpm run gen-component MyComponent
|
||||
```
|
||||
|
||||
The command will generate a new folder inside the `ui-components` directory, with the following files:
|
||||
@@ -76,7 +76,7 @@ Use cases of the component should be added to the Storybook file (`.stories.tsx`
|
||||
To start Storybook, run the following command from the root directory:
|
||||
|
||||
```bash
|
||||
npm run storybook
|
||||
pnpm run storybook
|
||||
```
|
||||
|
||||
The Storybook page is available on [http://localhost:6006](http://localhost:6006).
|
||||
@@ -88,7 +88,7 @@ We use [React Testing Library](https://testing-library.com/docs/react-testing-li
|
||||
To run tests against the component library, run the following command from the root directory:
|
||||
|
||||
```bash
|
||||
npm run test-ui-components
|
||||
pnpm run test-ui-components
|
||||
```
|
||||
|
||||
## Adding packages to the UI-Component library
|
||||
@@ -96,7 +96,8 @@ npm run test-ui-components
|
||||
We restrict adding new packages to the UI Components to help with the project's maintainability. In the rare chance that you think a dependency is needed, please check with the maintainers first and then use the following command to add a package:
|
||||
|
||||
```bash
|
||||
npm i -w=tools/ui-components package_name
|
||||
cd tools/ui-components
|
||||
pnpm add package_name
|
||||
```
|
||||
|
||||
### Useful links
|
||||
|
||||
@@ -50,13 +50,13 @@ Install freeCodeCamp locally ([see the local setup guide](how-to-setup-freecodec
|
||||
#### Serve and launch the documentation site only
|
||||
|
||||
```console
|
||||
npm run docs:serve
|
||||
pnpm run docs:serve
|
||||
```
|
||||
|
||||
#### Serve the documentation site alongside freeCodeCamp locally:
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
> The documentation site should be available at <http://localhost:3400>
|
||||
|
||||
@@ -17,10 +17,10 @@ If you are on a different OS or are still facing issues, see [getting help](#get
|
||||
When you build the client, Gatsby will cache the Fonts, language strings and UI. If one of them isn't cached, run the following:
|
||||
|
||||
```console
|
||||
npm run clean
|
||||
npm ci
|
||||
npm run seed
|
||||
npm run develop
|
||||
pnpm run clean
|
||||
pnpm install
|
||||
pnpm run seed
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
OR
|
||||
@@ -28,7 +28,7 @@ OR
|
||||
Use the shortcut
|
||||
|
||||
```
|
||||
npm run clean-and-develop
|
||||
pnpm run clean-and-develop
|
||||
```
|
||||
|
||||
If you continue to face issues with the build, cleaning up the workspace is recommend.
|
||||
@@ -78,7 +78,7 @@ TCP 0.0.0.0:3000 DESKTOP LISTENING
|
||||
|
||||
While in development, your session is stored as cookies. Clearing them will sign you out of your development account.
|
||||
|
||||
Running `npm run seed:certified-user` will log you out, too. It will overwrite the development user in your local database.
|
||||
Running `pnpm run seed:certified-user` will log you out, too. It will overwrite the development user in your local database.
|
||||
|
||||
### Issue getting 404 when navigating profile page
|
||||
|
||||
|
||||
@@ -91,7 +91,7 @@ Actualmente, solo los miembros del equipo de desarrolladores pueden enviar cambi
|
||||
4. Confirme que puede crear el repositorio localmente.
|
||||
|
||||
```
|
||||
npm run clean-and-develop
|
||||
pnpm run clean-and-develop
|
||||
```
|
||||
|
||||
5. Mueve los cambios desde `main` a `prod-staging` mediante una fusión fast-forward
|
||||
@@ -453,13 +453,13 @@ Aprovisionamiento de MVs con el código
|
||||
6. Instala las dependencias
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
7. Compila el servidor
|
||||
|
||||
```console
|
||||
npm run prebuild && npm run build:curriculum && npm run build:server
|
||||
pnpm run prebuild && pnpm run build:curriculum && pnpm run build:server
|
||||
```
|
||||
|
||||
8. Inicia las Instancias
|
||||
@@ -496,13 +496,13 @@ pm2 stop all
|
||||
2. Instala las dependencias
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
3. Construye el servidor
|
||||
|
||||
```console
|
||||
npm run create:config && npm run build:curriculum && npm run build:server
|
||||
pnpm run create:config && pnpm run build:curriculum && pnpm run build:server
|
||||
```
|
||||
|
||||
4. Inicia las Instancias
|
||||
@@ -788,8 +788,8 @@ ssh en la máquina virtual (alojada en Digital Ocean).
|
||||
```console
|
||||
cd tools
|
||||
git pull origin master
|
||||
npm ci
|
||||
npm run build
|
||||
pnpm install
|
||||
pnpm run build
|
||||
pm2 restart contribute-app
|
||||
```
|
||||
|
||||
|
||||
@@ -27,25 +27,25 @@ Para ejecutar pruebas en las compilaciones de producción, reemplaza `dev` con `
|
||||
- Para ejecutar todas las pruebas en el directorio `./cypress`:
|
||||
|
||||
```console
|
||||
npm run cypress:dev:run
|
||||
pnpm run cypress:dev:run
|
||||
```
|
||||
|
||||
- Para ejecutar una sola prueba:
|
||||
|
||||
```console
|
||||
npm run cypress -- run --spec=cypress/<path_to_test_file>
|
||||
pnpm run cypress -- run --spec=cypress/<path_to_test_file>
|
||||
```
|
||||
|
||||
For example:
|
||||
|
||||
```console
|
||||
npm run cypress -- run --spec=cypress/e2e/default/landing.js
|
||||
pnpm run cypress -- run --spec=cypress/e2e/default/landing.js
|
||||
```
|
||||
|
||||
- Para crear una compilación de desarrollo, inicia el servidor de desarrollo y ejecuta todas las pruebas de cypress existentes de extremo a extremo:
|
||||
|
||||
```console
|
||||
npm run e2e:dev:run
|
||||
pnpm run e2e:dev:run
|
||||
```
|
||||
|
||||
## Configuración de Cypress-GitPod
|
||||
@@ -63,19 +63,19 @@ mongod
|
||||
- Propaga la base de datos
|
||||
|
||||
```console
|
||||
npm run seed
|
||||
pnpm run seed
|
||||
```
|
||||
|
||||
- Inicia el servidor de desarrollo y cliente
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
### 2. Instala las herramientas de compilación de Cypress
|
||||
|
||||
```console
|
||||
npm run cypress:install-build-tools
|
||||
pnpm run cypress:install-build-tools
|
||||
```
|
||||
|
||||
- Cuando se te solicite en la terminal, selecciona la distribución de tu teclado por idioma / área
|
||||
|
||||
@@ -201,15 +201,15 @@ After you've committed your changes, check here for [how to open a Pull Request]
|
||||
|
||||
A quick reference to the commands that you will need when working.
|
||||
|
||||
| command | description |
|
||||
| -------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `npm test` | Run all JS tests in the system, including client, server, lint and challenge tests. |
|
||||
| `npm run test-client` | Run the client test suite. |
|
||||
| `npm run test:curriculum` | Run the curriculum test suite. |
|
||||
| `npm run test:curriculum --block='Basic HTML and HTML5'` | Test a specific Block. |
|
||||
| `npm run test:curriculum --superblock='responsive-web-design'` | Test a specific SuperBlock. |
|
||||
| `npm run test-curriculum-full-output` | Run the curriculum test suite, without bailing after the first error |
|
||||
| `npm run test-server` | Run the server test suite. |
|
||||
| `npm run e2e` | Run the Cypress end to end tests. |
|
||||
| `npm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
| `npm run storybook` | Starts Storybook for component library development. |
|
||||
| command | description |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `pnpm test` | Run all JS tests in the system, including client, server, lint and challenge tests. |
|
||||
| `pnpm run test-client` | Run the client test suite. |
|
||||
| `pnpm run test:curriculum` | Run the curriculum test suite. |
|
||||
| `FCC_BLOCK='Basic HTML and HTML5' pnpm run test:curriculum` | Test a specific Block. |
|
||||
| `FCC_SUPERBLOCK='responsive-web-design' pnpm run test:curriculum` | Test a specific SuperBlock. |
|
||||
| `pnpm run test-curriculum-full-output` | Run the curriculum test suite, without bailing after the first error |
|
||||
| `pnpm run test-server` | Run the server test suite. |
|
||||
| `pnpm run e2e` | Run the Cypress end to end tests. |
|
||||
| `pnpm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
| `pnpm run storybook` | Starts Storybook for component library development. |
|
||||
|
||||
@@ -293,9 +293,9 @@ Una vez que poseas los archivos, necesitarás colocarlos en el directorio correc
|
||||
|
||||
Actualice su archivo `.env` para usar su nuevo idioma para `CLIENT_LOCALE` y `CURRICULUM_LOCALE`.
|
||||
|
||||
Una vez que estos esten en su lugar, deberías ser capaz de correr `npm run develop` para ver tu versión traducida de freeCodeCamp.
|
||||
Once these are in place, you should be able to run `pnpm run develop` to view your translated version of freeCodeCamp.
|
||||
|
||||
> [!TIP] If you build the client in one language and then want to build it in a different language, you will need to use the command `npm run clean-and-develop` after changing the `.env` file, as Gatsby will cache the first language.
|
||||
> [!TIP] If you build the client in one language and then want to build it in a different language, you will need to use the command `pnpm run clean-and-develop` after changing the `.env` file, as Gatsby will cache the first language.
|
||||
|
||||
> [!ATTENTION] Si bien puedes realizar traducciones localmente con motivos de prueba, le recordamos a todos que las traducciones _no_ deben ser enviadas a través de GitHub, estas deben ser enviadas únicamente a traves de Crowdin. Asegúrate de reestablecer tu base de código local despues de que hayas finalizado con las pruebas.
|
||||
|
||||
|
||||
@@ -188,14 +188,14 @@ When you are working on features for our upcoming curriculum `next-*` branches,
|
||||
4. Resolve any conflicts, cleanup, install dependencies and run tests
|
||||
|
||||
```console
|
||||
npm run clean
|
||||
pnpm run clean
|
||||
|
||||
npm ci
|
||||
npm run test:curriculum --superblock=<superblock-name>
|
||||
pnpm install
|
||||
FCC_SUPERBLOCK='<superblock-name>' pnpm run test:curriculum
|
||||
|
||||
# example:
|
||||
|
||||
# npm run test:curriculum --superblock=python-for-everybody
|
||||
# FCC_SUPERBLOCK='python-for-everybody' pnpm run test:curriculum
|
||||
|
||||
```
|
||||
|
||||
|
||||
@@ -75,7 +75,7 @@ Some community members also develop on Windows natively with Git for Windows (Gi
|
||||
| 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/). |
|
||||
| npm (viene empaquetado con Node) | `8.x` | Utilizamos la versión empaquetada con Node.js Active LTS. |
|
||||
| [pnpm](https://pnpm.io/installation) | `7.x` | - |
|
||||
| [Servidor de la comunidad MongoDB](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.
|
||||
@@ -84,7 +84,7 @@ If Node.js is already installed on your machine, run the following commands to v
|
||||
|
||||
```console
|
||||
node -v
|
||||
npm -v
|
||||
pnpm -v
|
||||
```
|
||||
|
||||
> [!TIP] We highly recommend updating to the latest stable releases of the software listed above, also known as Long Term Support (LTS) releases.
|
||||
@@ -214,7 +214,7 @@ The keys in the `.env` file are _not_ required to be changed to run the app loca
|
||||
This step will install the dependencies required for the application to run:
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
#### Paso 3: Iniciar MongoDB y "sembrar" la base de datos
|
||||
@@ -252,7 +252,7 @@ Make sure to replace `3.6` with the version you have installed
|
||||
Next, let's seed the database. In this step, we run the below command that fills the MongoDB server with some initial data sets that are required by services. These include a few schemas, among other things.
|
||||
|
||||
```console
|
||||
npm run seed
|
||||
pnpm run seed
|
||||
```
|
||||
|
||||
#### Paso 4: Iniciar la aplicación del cliente freeCodeCamp y el servidor de la API
|
||||
@@ -260,7 +260,7 @@ npm run seed
|
||||
You can now start up the API server and the client applications.
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
This single command will fire up all the services, including the API server and the client applications available for you to work on.
|
||||
@@ -271,7 +271,7 @@ The API serves endpoints at `http://localhost:3000`. The Gatsby app serves the c
|
||||
|
||||
While you are logged in, if you visit <http://localhost:3000/explorer> you should see the available APIs.
|
||||
|
||||
> [!WARNING] Clearing your cookies or running `npm run seed:certified-user` will log you out, and you will have to sign in again.
|
||||
> [!WARNING] Clearing your cookies or running `pnpm run seed:certified-user` will log you out, and you will have to sign in again.
|
||||
|
||||
If you have issues while installing it, check out the [troubleshooting section](troubleshooting-development-issues.md)
|
||||
|
||||
@@ -279,9 +279,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 |
|
||||
| ----------------- | ------------------------------------------------------------------------------ |
|
||||
| `npm ci` | Instala / reinstala todas las dependencias y arranca los diferentes servicios. |
|
||||
| `npm run seed` | Creates authorized test users and inserts them into mongodb. |
|
||||
| `npm run develop` | Inicia el servidor freeCodeCamp API y las aplicaciones de cliente. |
|
||||
| `npm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
| 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. |
|
||||
|
||||
@@ -12,4 +12,4 @@ Si ves mensajes como
|
||||
bash: change_volumes_owner.sh: No such file or directory
|
||||
```
|
||||
|
||||
al ejecutar `npm run docker:init` es probable que esto sea el culpable.
|
||||
when you `pnpm run docker:init` this is likely the culprit.
|
||||
|
||||
@@ -460,17 +460,17 @@ Antes de que tu [hagas un pull request](how-to-open-a-pull-request.md) para tus
|
||||
1. Para testear todos los desafíos, ejecuta el siguiente comando desde el directorio raíz
|
||||
|
||||
````
|
||||
npm run test:curriculum
|
||||
pnpm run test:curriculum
|
||||
```
|
||||
|
||||
2. También puedes probar un bloque o un superbloque de desafíos con estos comandos
|
||||
|
||||
```
|
||||
npm run test:curriculum --block='Basic HTML and HTML5'
|
||||
FCC_BLOCK='Basic HTML and HTML5' pnpm run test:curriculum
|
||||
```
|
||||
|
||||
```
|
||||
npm run test:curriculum --superblock=responsive-web-design
|
||||
FCC_SUPERBLOCK='responsive-web-design' pnpm run test:curriculum
|
||||
```
|
||||
|
||||
También puedes probar un desafío individualmente realizando los siguientes pasos:
|
||||
@@ -484,7 +484,7 @@ También puedes probar un desafío individualmente realizando los siguientes pas
|
||||
2. Ejecute lo siguiente para cada archivo de desafío para el que haya cambiado (sustituyendo "el-titulo-del-desafio-va-aqui" por el título completo del desafío):
|
||||
|
||||
```
|
||||
npm run test -- -g el-titulo-del-desafio-va-aqui ```
|
||||
pnpm run test -- -g challenge-title-goes-here ```
|
||||
|
||||
Una vez que haya verificado que cada desafío en el que ha trabajado supera las pruebas, [cree una solicitud de extracción](how-to-open-a-pull-request.md).
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ Estas instrucciones le indicarán cómo utilizar nuestra herramienta de edición
|
||||
|
||||
### Iniciar el Editor
|
||||
|
||||
Para iniciar el editor, asegúrese de estar en el directorio raíz de freecodecamp. Luego, ejecute `npm run challenge-editor` para iniciar tanto el cliente como la API que alimenta el editor.
|
||||
Para iniciar el editor, asegúrese de estar en el directorio raíz de freecodecamp. Then, run `pnpm run challenge-editor` to start both the client and the API that powers the editor.
|
||||
|
||||
El cliente se ejecutará en el puerto `3300`, por lo que puede acceder a él en `http://localhost:3300`. La API se ejecuta en el puerto `3200` para evitar conflictos con el cliente y el servidor de aprendizaje. Esto le permitirá ejecutar la aplicación freeCodeCamp al mismo tiempo que el editor, para que pueda probar sus cambios localmente.
|
||||
|
||||
@@ -60,7 +60,7 @@ The `tools/challenge-helper-scripts` folder contains tools to help facilitate th
|
||||
|
||||
### Create a new project
|
||||
|
||||
Run `npm run create-project` from the root directory. This opens up a command line ui that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/01-responsive-web-design/test-project`.
|
||||
Run `pnpm run create-project` from the root directory. This opens up a command line ui that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/01-responsive-web-design/test-project`.
|
||||
|
||||
If you want to create new steps, the following tools simplify that process.
|
||||
|
||||
@@ -71,10 +71,10 @@ A one-off script that will automatically add the next step based on the last ste
|
||||
#### How to run script:
|
||||
|
||||
1. Redirígete al directorio del proyecto.
|
||||
2. Ejecuta el siguiente comando npm:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
Ejecuta npm crear siguiente paso
|
||||
pnpm run create-next-step
|
||||
```
|
||||
|
||||
### create-empty-steps
|
||||
@@ -86,10 +86,10 @@ A one-off script that automatically adds a specified number of steps. The challe
|
||||
#### How to run script:
|
||||
|
||||
1. Redirígete al directorio del proyecto.
|
||||
2. Ejecuta el siguiente comando npm:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run create-empty-steps X # donde X es el número de pasos a crear.
|
||||
pnpm run create-empty-steps X # where X is the number of steps to create.
|
||||
```
|
||||
|
||||
### insert-step
|
||||
@@ -101,10 +101,10 @@ A one-off script that automatically adds a new step at a specified position, inc
|
||||
#### How to run script:
|
||||
|
||||
1. Redirígete al directorio principal del proyecto.
|
||||
2. Ejecuta el siguiente comando npm:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run insert-step X # donde X es la posición para insertar el nuevo paso.
|
||||
pnpm run insert-step X # where X is the position to insert the new step.
|
||||
```
|
||||
|
||||
### delete-step
|
||||
@@ -116,10 +116,10 @@ A one-off script that deletes an existing step, decrementing all subsequent step
|
||||
#### How to run script
|
||||
|
||||
1. Redirígete al directorio principal del proyecto.
|
||||
2. Ejecuta el siguiente comando npm:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm ejecuta delete-step X # donde X es el número de paso a ser eliminado.
|
||||
pnpm run delete-step X # where X is the step number to be deleted.
|
||||
```
|
||||
|
||||
### update-step-titles
|
||||
@@ -129,8 +129,8 @@ A one-off script that automatically updates the frontmatter in a project's markd
|
||||
#### Como ejecutar un script
|
||||
|
||||
1. Redirígete al directorio del proyecto.
|
||||
2. Ejecuta el siguiente comando npm:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run update-step-titles
|
||||
pnpm run update-step-titles
|
||||
```
|
||||
|
||||
@@ -30,7 +30,7 @@ Se puede crear un nuevo componente utilizando el siguiente comando desde el dire
|
||||
```bash
|
||||
cd tools/ui-components
|
||||
|
||||
npm run gen-component MyComponent
|
||||
pnpm run gen-component MyComponent
|
||||
```
|
||||
|
||||
El comando generará una nueva carpeta dentro del directorio `ui-components`, con los siguientes archivos:
|
||||
@@ -76,7 +76,7 @@ Los casos de uso del componente deben añadirse al archivo Storybook (`.stories.
|
||||
Para iniciar Storybook, ejecute el siguiente comando desde el directorio raíz:
|
||||
|
||||
```bash
|
||||
npm run storybook
|
||||
pnpm run storybook
|
||||
```
|
||||
|
||||
La página Storybook está disponible en [http://localhost:6006](http://localhost:6006).
|
||||
@@ -88,7 +88,7 @@ Usamos [React Testing Library](https://testing-library.com/docs/react-testing-li
|
||||
Para ejecutar pruebas a la biblioteca de componentes, ejecute el siguiente comando desde el directorio raíz:
|
||||
|
||||
```bash
|
||||
npm run test-ui-components
|
||||
pnpm run test-ui-components
|
||||
```
|
||||
|
||||
## Adding packages to the UI-Component library
|
||||
@@ -96,7 +96,8 @@ npm run test-ui-components
|
||||
We restrict adding new packages to the UI Components to help with the project's maintainability. In the rare chance that you think a dependency is needed, please check with the maintainers first and then use the following command to add a package:
|
||||
|
||||
```bash
|
||||
npm i -w=tools/ui-components package_name
|
||||
cd tools/ui-components
|
||||
pnpm add package_name
|
||||
```
|
||||
|
||||
### Enlaces útiles
|
||||
|
||||
@@ -50,13 +50,13 @@ Install freeCodeCamp locally ([see the local setup guide](how-to-setup-freecodec
|
||||
#### Ejecutar y lanzar solo el sitio de documentación
|
||||
|
||||
```console
|
||||
npm run docs:serve
|
||||
pnpm run docs:serve
|
||||
```
|
||||
|
||||
#### Servir el sitio de documentación junto a freeCodeCamp local:
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
> The documentation site should be available at <http://localhost:3400>
|
||||
|
||||
@@ -17,10 +17,10 @@ If you are on a different OS or are still facing issues, see [getting help](#get
|
||||
When you build the client, Gatsby will cache the Fonts, language strings and UI. If one of them isn't cached, run the following:
|
||||
|
||||
```console
|
||||
npm run clean
|
||||
npm ci
|
||||
npm run seed
|
||||
npm run develop
|
||||
pnpm run clean
|
||||
pnpm install
|
||||
pnpm run seed
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
OR
|
||||
@@ -28,7 +28,7 @@ OR
|
||||
Use the shortcut
|
||||
|
||||
```
|
||||
npm run clean-and-develop
|
||||
pnpm run clean-and-develop
|
||||
```
|
||||
|
||||
If you continue to face issues with the build, cleaning up the workspace is recommend.
|
||||
@@ -78,7 +78,7 @@ TCP 0.0.0.0:3000 DESKTOP LISTENING
|
||||
|
||||
While in development, your session is stored as cookies. Clearing them will sign you out of your development account.
|
||||
|
||||
Running `npm run seed:certified-user` will log you out, too. It will overwrite the development user in your local database.
|
||||
Running `pnpm run seed:certified-user` will log you out, too. It will overwrite the development user in your local database.
|
||||
|
||||
### Issue getting 404 when navigating profile page
|
||||
|
||||
|
||||
@@ -91,7 +91,7 @@ Derzeit können nur Mitglieder des Entwicklerteams in die Produktionsbranches pu
|
||||
4. Bestätige dass du in der Lage bist, das Repository lokal zu erstellen.
|
||||
|
||||
```
|
||||
npm run clean-and-develop
|
||||
pnpm run clean-and-develop
|
||||
```
|
||||
|
||||
5. Verschieben von Änderungen von `main` nach `prod-staging` über ein Fast-Forward-Merge
|
||||
@@ -453,13 +453,13 @@ Bereitstellung von VMs mit dem Code
|
||||
6. Installiere Abhängigkeiten
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
7. Errichte den Server.
|
||||
|
||||
```console
|
||||
npm run prebuild && npm run build:curriculum && npm run build:server
|
||||
pnpm run prebuild && pnpm run build:curriculum && pnpm run build:server
|
||||
```
|
||||
|
||||
8. Starte Instanzen
|
||||
@@ -496,13 +496,13 @@ pm2 stop all
|
||||
2. Installiere Abhängigkeiten
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
3. Errichte den Server
|
||||
|
||||
```console
|
||||
npm run create:config && npm run build:curriculum && npm run build:server
|
||||
pnpm run create:config && pnpm run build:curriculum && pnpm run build:server
|
||||
```
|
||||
|
||||
4. Starte Instanzen
|
||||
@@ -788,8 +788,8 @@ ssh in die VM (gehostet auf Digital Ocean).
|
||||
```console
|
||||
cd tools
|
||||
git pull origin master
|
||||
npm ci
|
||||
npm run build
|
||||
pnpm install
|
||||
pnpm run build
|
||||
pm2 restart contribute-app
|
||||
```
|
||||
|
||||
|
||||
@@ -27,25 +27,25 @@ Um Tests mit Produktions-Builds durchzuführen, ersetze unten `dev` durch `prd`.
|
||||
- Um alle Tests im Verzeichnis `./cypress` auszuführen:
|
||||
|
||||
```console
|
||||
npm run cypress:dev:run
|
||||
pnpm run cypress:dev:run
|
||||
```
|
||||
|
||||
- Um einen einzelnen Test durchzuführen:
|
||||
|
||||
```console
|
||||
npm run cypress -- run --spec=cypress/<path_to_test_file>
|
||||
pnpm run cypress -- run --spec=cypress/<path_to_test_file>
|
||||
```
|
||||
|
||||
For example:
|
||||
|
||||
```console
|
||||
npm run cypress -- run --spec=cypress/e2e/default/landing.js
|
||||
pnpm run cypress -- run --spec=cypress/e2e/default/landing.js
|
||||
```
|
||||
|
||||
- Um einen Entwicklungs-Build zu erstellen, starte den Entwicklungsserver und führe alle vorhandenen Cypress-End-to-End-Tests aus:
|
||||
|
||||
```console
|
||||
npm run e2e:dev:run
|
||||
pnpm run e2e:dev:run
|
||||
```
|
||||
|
||||
## Cypress-GitPod Setup
|
||||
@@ -63,19 +63,19 @@ mongod
|
||||
- Richte die Datenbank ein
|
||||
|
||||
```console
|
||||
npm run seed
|
||||
pnpm run seed
|
||||
```
|
||||
|
||||
- Entwickle den Server und den Client
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
### 2. Cypress Build Tools installieren
|
||||
|
||||
```console
|
||||
npm run cypress:install-build-tools
|
||||
pnpm run cypress:install-build-tools
|
||||
```
|
||||
|
||||
- Wenn du im Terminal dazu aufgefordert wirst, wähle dein Tastaturlayout nach Sprache/Region aus
|
||||
|
||||
@@ -201,15 +201,15 @@ After you've committed your changes, check here for [how to open a Pull Request]
|
||||
|
||||
A quick reference to the commands that you will need when working.
|
||||
|
||||
| command | description |
|
||||
| -------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `npm test` | Run all JS tests in the system, including client, server, lint and challenge tests. |
|
||||
| `npm run test-client` | Run the client test suite. |
|
||||
| `npm run test:curriculum` | Run the curriculum test suite. |
|
||||
| `npm run test:curriculum --block='Basic HTML and HTML5'` | Test a specific Block. |
|
||||
| `npm run test:curriculum --superblock='responsive-web-design'` | Test a specific SuperBlock. |
|
||||
| `npm run test-curriculum-full-output` | Run the curriculum test suite, without bailing after the first error |
|
||||
| `npm run test-server` | Run the server test suite. |
|
||||
| `npm run e2e` | Run the Cypress end to end tests. |
|
||||
| `npm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
| `npm run storybook` | Starts Storybook for component library development. |
|
||||
| command | description |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `pnpm test` | Run all JS tests in the system, including client, server, lint and challenge tests. |
|
||||
| `pnpm run test-client` | Run the client test suite. |
|
||||
| `pnpm run test:curriculum` | Run the curriculum test suite. |
|
||||
| `FCC_BLOCK='Basic HTML and HTML5' pnpm run test:curriculum` | Test a specific Block. |
|
||||
| `FCC_SUPERBLOCK='responsive-web-design' pnpm run test:curriculum` | Test a specific SuperBlock. |
|
||||
| `pnpm run test-curriculum-full-output` | Run the curriculum test suite, without bailing after the first error |
|
||||
| `pnpm run test-server` | Run the server test suite. |
|
||||
| `pnpm run e2e` | Run the Cypress end to end tests. |
|
||||
| `pnpm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
| `pnpm run storybook` | Starts Storybook for component library development. |
|
||||
|
||||
@@ -293,9 +293,9 @@ Sobald du die Dateien hast, musst du sie im richtigen Verzeichnis ablegen. Für
|
||||
|
||||
Aktualisiere deine `.env`-Datei, um deine neue Sprache für `CLIENT_LOCALE` und `CURRICULUM_LOCALE` zu verwenden.
|
||||
|
||||
Sobald du diese Einstellungen vorgenommen hast, solltest du `npm run develop` ausführen können, um deine übersetzte Version von freeCodeCamp anzuzeigen.
|
||||
Once these are in place, you should be able to run `pnpm run develop` to view your translated version of freeCodeCamp.
|
||||
|
||||
> [!TIP] If you build the client in one language and then want to build it in a different language, you will need to use the command `npm run clean-and-develop` after changing the `.env` file, as Gatsby will cache the first language.
|
||||
> [!TIP] If you build the client in one language and then want to build it in a different language, you will need to use the command `pnpm run clean-and-develop` after changing the `.env` file, as Gatsby will cache the first language.
|
||||
|
||||
> [!ATTENTION] Du kannst zwar lokal Übersetzungen zu Testzwecken vornehmen, aber wir erinnern alle daran, dass Übersetzungen _nicht_ über GitHub eingereicht werden sollten und nur über Crowdin erfolgen sollten. Achte darauf, dass du deine lokale Codebasis zurücksetzt, wenn du mit dem Testen fertig bist.
|
||||
|
||||
|
||||
@@ -188,14 +188,14 @@ Wenn du an Funktionen für unseren kommenden `next-*`-Branch arbeitest, musst du
|
||||
4. Behebe alle Konflikte, bereinige, installiere Abhängigkeiten und führe Tests durch
|
||||
|
||||
```console
|
||||
npm run clean
|
||||
pnpm run clean
|
||||
|
||||
npm ci
|
||||
npm run test:curriculum --superblock=<superblock-name>
|
||||
pnpm install
|
||||
FCC_SUPERBLOCK='<superblock-name>' pnpm run test:curriculum
|
||||
|
||||
# Beispiel:
|
||||
# example:
|
||||
|
||||
# npm run test:curriculum --superblock=python-for-everyone
|
||||
# FCC_SUPERBLOCK='python-for-everybody' pnpm run test:curriculum
|
||||
|
||||
```
|
||||
|
||||
|
||||
@@ -75,7 +75,7 @@ Some community members also develop on Windows natively with Git for Windows (Gi
|
||||
| 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/). |
|
||||
| npm (wird mit Node mitgeliefert) | `8.x` | Wir verwenden die Version, die mit Node.js Active LTS ausgeliefert wird. |
|
||||
| [pnpm](https://pnpm.io/installation) | `7.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.
|
||||
@@ -84,7 +84,7 @@ If Node.js is already installed on your machine, run the following commands to v
|
||||
|
||||
```console
|
||||
node -v
|
||||
npm -v
|
||||
pnpm -v
|
||||
```
|
||||
|
||||
> [!TIP] We highly recommend updating to the latest stable releases of the software listed above, also known as Long Term Support (LTS) releases.
|
||||
@@ -214,7 +214,7 @@ The keys in the `.env` file are _not_ required to be changed to run the app loca
|
||||
This step will install the dependencies required for the application to run:
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
#### Schritt 3: MongoDB starten und die Datenbank initialisieren
|
||||
@@ -252,7 +252,7 @@ Make sure to replace `3.6` with the version you have installed
|
||||
Next, let's seed the database. In this step, we run the below command that fills the MongoDB server with some initial data sets that are required by services. These include a few schemas, among other things.
|
||||
|
||||
```console
|
||||
npm run seed
|
||||
pnpm run seed
|
||||
```
|
||||
|
||||
#### Schritt 4: Starte die freeCodeCamp Client-Anwendung und den API-Server
|
||||
@@ -260,7 +260,7 @@ npm run seed
|
||||
You can now start up the API server and the client applications.
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
This single command will fire up all the services, including the API server and the client applications available for you to work on.
|
||||
@@ -271,7 +271,7 @@ The API serves endpoints at `http://localhost:3000`. The Gatsby app serves the c
|
||||
|
||||
While you are logged in, if you visit <http://localhost:3000/explorer> you should see the available APIs.
|
||||
|
||||
> [!WARNING] Clearing your cookies or running `npm run seed:certified-user` will log you out, and you will have to sign in again.
|
||||
> [!WARNING] Clearing your cookies or running `pnpm run seed:certified-user` will log you out, and you will have to sign in again.
|
||||
|
||||
If you have issues while installing it, check out the [troubleshooting section](troubleshooting-development-issues.md)
|
||||
|
||||
@@ -279,9 +279,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 |
|
||||
| ----------------- | ------------------------------------------------------------------------------------- |
|
||||
| `npm ci` | Installiert / reinstalliert alle Abhängigkeiten und bootet die verschiedenen Dienste. |
|
||||
| `npm run seed` | Creates authorized test users and inserts them into mongodb. |
|
||||
| `npm run develop` | Startet den freeCodeCamp API Server und die Client-Anwendungen. |
|
||||
| `npm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
| 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. |
|
||||
|
||||
@@ -12,4 +12,4 @@ Wenn du Meldungen siehst wie
|
||||
bash: change_volumes_owner.sh: No such file or directory
|
||||
```
|
||||
|
||||
wenn du `npm run docker:init` ausführst, ist das wahrscheinlich der Grund dafür.
|
||||
when you `pnpm run docker:init` this is likely the culprit.
|
||||
|
||||
@@ -456,17 +456,17 @@ Bevor du [einen Pull-Request](how-to-open-a-pull-request.md) für deine Änderun
|
||||
1. Um alle Aufgaben zu testen, führe den folgenden Befehl im Stammverzeichnis aus
|
||||
|
||||
````
|
||||
npm run test:curriculum
|
||||
pnpm run test:curriculum
|
||||
```
|
||||
|
||||
2. Du kannst auch einen Block oder einen Superblock von Aufgaben mit diesen Befehlen testen
|
||||
|
||||
```
|
||||
npm run test:curriculum --block='Basic HTML and HTML5'
|
||||
FCC_BLOCK='Basic HTML and HTML5' pnpm run test:curriculum
|
||||
```
|
||||
|
||||
```
|
||||
npm run test:curriculum --superblock=responsive-web-design
|
||||
FCC_SUPERBLOCK='responsive-web-design' pnpm run test:curriculum
|
||||
```
|
||||
|
||||
Du kannst eine Aufgabe auch einzeln testen, indem du die folgenden Schritte ausführst:
|
||||
@@ -480,7 +480,7 @@ Du kannst eine Aufgabe auch einzeln testen, indem du die folgenden Schritte ausf
|
||||
2. Führe das Folgende für jede Aufgabendatei aus, für die du Änderungen vorgenommen hast (ersetze dabei `Aufgabentitel hier eintragen` durch den vollständigen Titel der Aufgabe):
|
||||
|
||||
```
|
||||
npm run test -- -g Aufgabentitel hier eintragen ```
|
||||
pnpm run test -- -g challenge-title-goes-here ```
|
||||
|
||||
Sobald du sichergestellt hast, dass jede Aufgabe, an der du gearbeitet hast, die Tests besteht, [erstelle bitte einen Pull-Request](how-to-open-a-pull-request.md).
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ In dieser Anleitung erfährst du, wie du mit unserem Aufgaben-Editor an den Übu
|
||||
|
||||
### Starten des Editors
|
||||
|
||||
Um den Editor zu starten, stelle sicher, dass du dich im Stammverzeichnis von freeCodeCamp befindest. Führe dann `npm run challenge-editor` aus, um sowohl den Client als auch die API zu starten, die der Editor verwendet.
|
||||
Um den Editor zu starten, stelle sicher, dass du dich im Stammverzeichnis von freeCodeCamp befindest. Then, run `pnpm run challenge-editor` to start both the client and the API that powers the editor.
|
||||
|
||||
Der Client läuft auf Port `3300`, so dass du ihn unter `http://localhost:3300` erreichen kannst. Die API läuft auf Port `3200`, um Konflikte mit dem Lernclient und dem Server zu vermeiden. Dies ermöglicht es dir, die freeCodeCamp-Anwendung gleichzeitig mit dem Editor laufen zu lassen, so dass du deine Änderungen lokal testen kannst.
|
||||
|
||||
@@ -60,7 +60,7 @@ The `tools/challenge-helper-scripts` folder contains tools to help facilitate th
|
||||
|
||||
### Create a new project
|
||||
|
||||
Run `npm run create-project` from the root directory. This opens up a command line ui that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/01-responsive-web-design/test-project`.
|
||||
Run `pnpm run create-project` from the root directory. This opens up a command line ui that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/01-responsive-web-design/test-project`.
|
||||
|
||||
If you want to create new steps, the following tools simplify that process.
|
||||
|
||||
@@ -71,10 +71,10 @@ A one-off script that will automatically add the next step based on the last ste
|
||||
#### How to run script:
|
||||
|
||||
1. Wechsle in das Verzeichnis des Projekts.
|
||||
2. Führe den folgenden npm-Befehl aus:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run create-next-step
|
||||
pnpm run create-next-step
|
||||
```
|
||||
|
||||
### create-empty-steps
|
||||
@@ -86,10 +86,10 @@ A one-off script that automatically adds a specified number of steps. The challe
|
||||
#### How to run script:
|
||||
|
||||
1. Wechsle in das Verzeichnis des Projekts.
|
||||
2. Führe den folgenden npm-Befehl aus:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run create-empty-steps X # wobei X die Anzahl der zu erstellenden Schritte ist.
|
||||
pnpm run create-empty-steps X # where X is the number of steps to create.
|
||||
```
|
||||
|
||||
### insert-step
|
||||
@@ -101,10 +101,10 @@ A one-off script that automatically adds a new step at a specified position, inc
|
||||
#### How to run script:
|
||||
|
||||
1. Wechsle in das Verzeichnis des Projekts.
|
||||
2. Führe den folgenden npm-Befehl aus:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run insert-step X # wobei X die Position ist, an der der neue Schritt eingefügt werden soll.
|
||||
pnpm run insert-step X # where X is the position to insert the new step.
|
||||
```
|
||||
|
||||
### delete-step
|
||||
@@ -116,10 +116,10 @@ A one-off script that deletes an existing step, decrementing all subsequent step
|
||||
#### How to run script
|
||||
|
||||
1. Wechsle in das Verzeichnis des Projekts.
|
||||
2. Führe den folgenden npm-Befehl aus:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run delete-step X # wobei X die Schrittnummer ist, die gelöscht werden soll.
|
||||
pnpm run delete-step X # where X is the step number to be deleted.
|
||||
```
|
||||
|
||||
### update-step-titles
|
||||
@@ -129,8 +129,8 @@ A one-off script that automatically updates the frontmatter in a project's markd
|
||||
#### How to run script
|
||||
|
||||
1. Wechsle in das Verzeichnis des Projekts.
|
||||
2. Führe den folgenden npm-Befehl aus:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run update-step-titles
|
||||
pnpm run update-step-titles
|
||||
```
|
||||
|
||||
@@ -30,7 +30,7 @@ A new component can be created using the following command from the root directo
|
||||
```bash
|
||||
cd tools/ui-components
|
||||
|
||||
npm run gen-component MyComponent
|
||||
pnpm run gen-component MyComponent
|
||||
```
|
||||
|
||||
The command will generate a new folder inside the `ui-components` directory, with the following files:
|
||||
@@ -76,7 +76,7 @@ Use cases of the component should be added to the Storybook file (`.stories.tsx`
|
||||
To start Storybook, run the following command from the root directory:
|
||||
|
||||
```bash
|
||||
npm run storybook
|
||||
pnpm run storybook
|
||||
```
|
||||
|
||||
The Storybook page is available on [http://localhost:6006](http://localhost:6006).
|
||||
@@ -88,7 +88,7 @@ We use [React Testing Library](https://testing-library.com/docs/react-testing-li
|
||||
To run tests against the component library, run the following command from the root directory:
|
||||
|
||||
```bash
|
||||
npm run test-ui-components
|
||||
pnpm run test-ui-components
|
||||
```
|
||||
|
||||
## Adding packages to the UI-Component library
|
||||
@@ -96,7 +96,8 @@ npm run test-ui-components
|
||||
We restrict adding new packages to the UI Components to help with the project's maintainability. In the rare chance that you think a dependency is needed, please check with the maintainers first and then use the following command to add a package:
|
||||
|
||||
```bash
|
||||
npm i -w=tools/ui-components package_name
|
||||
cd tools/ui-components
|
||||
pnpm add package_name
|
||||
```
|
||||
|
||||
### Useful links
|
||||
|
||||
@@ -50,13 +50,13 @@ Install freeCodeCamp locally ([see the local setup guide](how-to-setup-freecodec
|
||||
#### Serve and launch the documentation site only
|
||||
|
||||
```console
|
||||
npm run docs:serve
|
||||
pnpm run docs:serve
|
||||
```
|
||||
|
||||
#### Serve the documentation site alongside freeCodeCamp locally:
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
> The documentation site should be available at <http://localhost:3400>
|
||||
|
||||
@@ -17,10 +17,10 @@ If you are on a different OS or are still facing issues, see [getting help](#get
|
||||
When you build the client, Gatsby will cache the Fonts, language strings and UI. If one of them isn't cached, run the following:
|
||||
|
||||
```console
|
||||
npm run clean
|
||||
npm ci
|
||||
npm run seed
|
||||
npm run develop
|
||||
pnpm run clean
|
||||
pnpm install
|
||||
pnpm run seed
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
OR
|
||||
@@ -28,7 +28,7 @@ OR
|
||||
Use the shortcut
|
||||
|
||||
```
|
||||
npm run clean-and-develop
|
||||
pnpm run clean-and-develop
|
||||
```
|
||||
|
||||
If you continue to face issues with the build, cleaning up the workspace is recommend.
|
||||
@@ -78,7 +78,7 @@ TCP 0.0.0.0:3000 DESKTOP LISTENING
|
||||
|
||||
While in development, your session is stored as cookies. Clearing them will sign you out of your development account.
|
||||
|
||||
Running `npm run seed:certified-user` will log you out, too. It will overwrite the development user in your local database.
|
||||
Running `pnpm run seed:certified-user` will log you out, too. It will overwrite the development user in your local database.
|
||||
|
||||
### Issue getting 404 when navigating profile page
|
||||
|
||||
|
||||
@@ -91,7 +91,7 @@ Attualmente, solo i membri del team di sviluppo possono fare il push sui branch
|
||||
4. Conferma di essere in grado di fare il build del repository localmente.
|
||||
|
||||
```
|
||||
npm run clean-and-develop
|
||||
pnpm run clean-and-develop
|
||||
```
|
||||
|
||||
5. Sposta cambiamenti da `main` a `prod-staging` con un merge fast-forward
|
||||
@@ -453,13 +453,13 @@ Fare il provisioning delle VM con il codice
|
||||
6. Installa dipendenze
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
7. Fai il build del server
|
||||
|
||||
```console
|
||||
npm run prebuild && npm run build:curriculum && npm run build:server
|
||||
pnpm run prebuild && pnpm run build:curriculum && pnpm run build:server
|
||||
```
|
||||
|
||||
8. Avvia le istanze
|
||||
@@ -496,13 +496,13 @@ pm2 stop all
|
||||
2. Installa dipendenze
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
3. Fai il build del server
|
||||
|
||||
```console
|
||||
npm run create:config && npm run build:curriculum && npm run build:server
|
||||
pnpm run create:config && pnpm run build:curriculum && pnpm run build:server
|
||||
```
|
||||
|
||||
4. Avvia le istanze
|
||||
@@ -788,8 +788,8 @@ Fai ssh nella VM (hosted su Digital Ocean).
|
||||
```console
|
||||
cd tools
|
||||
git pull origin master
|
||||
npm ci
|
||||
npm run build
|
||||
pnpm install
|
||||
pnpm run build
|
||||
pm2 restart contribute-app
|
||||
```
|
||||
|
||||
|
||||
@@ -27,25 +27,25 @@ Per eseguire i test su build di produzione, sostituisci `dev` con `prd` nella pa
|
||||
- Per eseguire tutti i test nella cartella `./cypress`:
|
||||
|
||||
```console
|
||||
npm run cypress:dev:run
|
||||
pnpm run cypress:dev:run
|
||||
```
|
||||
|
||||
- Per eseguire un singolo test:
|
||||
|
||||
```console
|
||||
npm run cypress -- run --spec=cypress/<percorso_file_test>
|
||||
pnpm run cypress -- run --spec=cypress/<path_to_test_file>
|
||||
```
|
||||
|
||||
Ad esempio:
|
||||
|
||||
```console
|
||||
npm run cypress -- run --spec=cypress/e2e/default/landing.js
|
||||
pnpm run cypress -- run --spec=cypress/e2e/default/landing.js
|
||||
```
|
||||
|
||||
- Per creare una build di sviluppo, avvia il server di sviluppo e esegui tutti i test cypress end-to-end esistenti:
|
||||
|
||||
```console
|
||||
npm run e2e:dev:run
|
||||
pnpm run e2e:dev:run
|
||||
```
|
||||
|
||||
## Setup di Cypress su GitPod
|
||||
@@ -63,19 +63,19 @@ mongod
|
||||
- Fai il seed del database
|
||||
|
||||
```console
|
||||
npm run seed
|
||||
pnpm run seed
|
||||
```
|
||||
|
||||
- Sviluppa il server e il client
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
### 2. Installa Cypress Build Tools
|
||||
|
||||
```console
|
||||
npm run cypress:install-build-tools
|
||||
pnpm run cypress:install-build-tools
|
||||
```
|
||||
|
||||
- Quando chiesto dal terminale, seleziona il layout della tua tastiera per lingua/area
|
||||
|
||||
@@ -201,15 +201,15 @@ Dopo aver fatto il commit delle tue modifiche, controlla qui [come aprire una Pu
|
||||
|
||||
Un rapido richiamo ai comandi di cui avrai bisogno lavorando.
|
||||
|
||||
| comando | descrizione |
|
||||
| -------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `npm test` | Esegue tutti i test JS del sistema inclusi client, server, lint e test delle sfide. |
|
||||
| `npm run test-client` | Esegue la test suite del client. |
|
||||
| `npm run test:curriculum` | Esegue la test suite del curriculum. |
|
||||
| `npm run test:curriculum --block='Basic HTML and HTML5'` | Esegue i test di uno specifico blocco. |
|
||||
| `npm run test:curriculum --superblock='responsive-web-design'` | Esegue i test di uno specifico superblocco. |
|
||||
| `npm run test-curriculum-full-output` | Esegue la suite di test del curriculum, senza arrestarsi dopo il primo errore |
|
||||
| `npm run test-server` | Esegue la suite di test del server. |
|
||||
| `npm run e2e` | Esegue i test di Cypress end to end. |
|
||||
| `npm run clean` | Disinstalla tutte le dipendenze e pulisce la cache. |
|
||||
| `npm run storybook` | Esegue Storybook per sviluppo dei componenti di library. |
|
||||
| comando | descrizione |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `pnpm test` | Esegue tutti i test JS del sistema inclusi client, server, lint e test delle sfide. |
|
||||
| `pnpm run test-client` | Esegue la test suite del client. |
|
||||
| `pnpm run test:curriculum` | Esegue la test suite del curriculum. |
|
||||
| `FCC_BLOCK='Basic HTML and HTML5' pnpm run test:curriculum` | Esegue i test di uno specifico blocco. |
|
||||
| `FCC_SUPERBLOCK='responsive-web-design' pnpm run test:curriculum` | Esegue i test di uno specifico superblocco. |
|
||||
| `pnpm run test-curriculum-full-output` | Esegue la suite di test del curriculum, senza arrestarsi dopo il primo errore |
|
||||
| `pnpm run test-server` | Esegue la suite di test del server. |
|
||||
| `pnpm run e2e` | Esegue i test di Cypress end to end. |
|
||||
| `pnpm run clean` | Disinstalla tutte le dipendenze e pulisce la cache. |
|
||||
| `pnpm run storybook` | Esegue Storybook per sviluppo dei componenti di library. |
|
||||
|
||||
@@ -293,9 +293,9 @@ Una volta che avrai i file, li dovrai mettere nelle cartelle giuste. Per le sfid
|
||||
|
||||
Aggiorna il file `.env` in modo da poter utilizzare la tua lingua per `CLIENT_LOCALE` e `CURRICULUM_LOCALE`.
|
||||
|
||||
Una volta che questi saranno in posizione, dovresti essere in grado di eseguire `npm run develop` per vedere la versione tradotta di freeCodeCamp.
|
||||
Once these are in place, you should be able to run `pnpm run develop` to view your translated version of freeCodeCamp.
|
||||
|
||||
> [!TIP] Se costruisci il client in una lingua e poi vuoi costruirlo in una lingua diversa, dovrai usare il comando `npm run clean-and-develop` dopo aver cambiato il file `.env`, dato che Gatsby memorizzerà nella cache la prima lingua.
|
||||
> [!TIP] If you build the client in one language and then want to build it in a different language, you will need to use the command `pnpm run clean-and-develop` after changing the `.env` file, as Gatsby will cache the first language.
|
||||
|
||||
> [!ATTENTION] Anche se puoi farei delle traduzioni localmente per i test, ricordiamo che le traduzioni _non_ devono essere inviate attraverso GitHub ma solo tramite Crowdin. Assicurati di resettare il tuo codebase locale dopo che avrai finito con i test.
|
||||
|
||||
|
||||
@@ -188,14 +188,14 @@ Quando stai lavorando su funzionalità dei rami `next-*` del nuovo curriculum, d
|
||||
4. Risolvi eventuali conflitti, fai pulizia, installa le dipendenze ed esegui i test
|
||||
|
||||
```console
|
||||
npm run clean
|
||||
pnpm run clean
|
||||
|
||||
npm ci
|
||||
npm run test:curriculum --superblock=<superblock-name>
|
||||
pnpm install
|
||||
FCC_SUPERBLOCK='<superblock-name>' pnpm run test:curriculum
|
||||
|
||||
# example:
|
||||
|
||||
# npm run test:curriculum --superblock=python-for-everybody
|
||||
# FCC_SUPERBLOCK='python-for-everybody' pnpm run test:curriculum
|
||||
|
||||
```
|
||||
|
||||
|
||||
@@ -75,7 +75,7 @@ Alcuni membri della comunità sviluppano anche su Windows nativamente con Git p
|
||||
| Prerequisito | Versione | Note |
|
||||
| --------------------------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------- |
|
||||
| [Node.js](http://nodejs.org) | `18.x` | Usiamo la versione "Active LTS", Vedi [LTS Schedule](https://nodejs.org/en/about/releases/). |
|
||||
| npm (viene fornito in bundle con node) | `8.x` | Usiamo la versione in bundle con Node.js Active LTS. |
|
||||
| [pnpm](https://pnpm.io/installation) | `7.x` | - |
|
||||
| [Server Community MongoDB](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.
|
||||
@@ -84,7 +84,7 @@ Se Node.js è già installato sulla macchina, esegui i seguenti comandi per conv
|
||||
|
||||
```console
|
||||
node -v
|
||||
npm -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).
|
||||
@@ -214,7 +214,7 @@ _Non_ è necessario cambiare le chiavi nel file `.env` per eseguire l'applicazio
|
||||
Questo passaggio installerà le dipendenze richieste per l'esecuzione dell'applicazione:
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
#### Passo 3: Avvia MongoDB e fai il seed del database
|
||||
@@ -252,7 +252,7 @@ Assicurati di sostituire `3.6` con la versione che hai installato
|
||||
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.
|
||||
|
||||
```console
|
||||
npm run seed
|
||||
pnpm run seed
|
||||
```
|
||||
|
||||
#### Passo 4: Avviare l'applicazione client freeCodeCamp e il server API
|
||||
@@ -260,7 +260,7 @@ npm run seed
|
||||
Ora è possibile avviare il server API e le applicazioni client.
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
Questo singolo comando attiverà tutti i servizi, compreso il server API e le applicazioni client disponibili su cui lavorare.
|
||||
@@ -271,7 +271,7 @@ Il server API serve gli endpoint su `http://localhost:3000`. L'app Gatsby serve
|
||||
|
||||
Mentre hai effettuato l'accesso, se visiti <http://localhost:3000/explorer> dovresti vedere le API disponibili.
|
||||
|
||||
> [!WARNING] Se pulisci i cookie o esegui `npm run seed:certified-user` perderai l'accesso e dovrai fare di nuovo l'accesso.
|
||||
> [!WARNING] Clearing your cookies or running `pnpm run seed:certified-user` will log you out, and you will have to sign in again.
|
||||
|
||||
Se hai problemi durante l'installazione, consulta la sezione [risoluzione dei problemi](troubleshooting-development-issues.md)
|
||||
|
||||
@@ -279,9 +279,9 @@ Se hai problemi durante l'installazione, consulta la sezione [risoluzione dei pr
|
||||
|
||||
Un rapido richiamo ai comandi di cui avrai bisogno quando lavorerai localmente.
|
||||
|
||||
| comando | descrizione |
|
||||
| ----------------- | -------------------------------------------------------------------- |
|
||||
| `npm ci` | Installa / reinstalla tutte le dipendenze e avvia i diversi servizi. |
|
||||
| `npm run seed` | Crea utenti di test autorizzati e li inserisce in mongodb. |
|
||||
| `npm run develop` | Avvia il server API freeCodeCamp e le applicazioni client. |
|
||||
| `npm run clean` | Disistalla tutte le dipendenze e pulisce la cache. |
|
||||
| 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. |
|
||||
|
||||
@@ -12,4 +12,4 @@ Se vedi messaggi come
|
||||
bash: change_volumes_owner.sh: No such file or directory
|
||||
```
|
||||
|
||||
quando usi `npm run docker:init` questa è molto probabilmente la causa.
|
||||
when you `pnpm run docker:init` this is likely the culprit.
|
||||
|
||||
@@ -457,17 +457,17 @@ Prima di [creare una pull request](how-to-open-a-pull-request.md), devi verifica
|
||||
1. Per testare tutte le sfide esegui il comando seguente nella directory root
|
||||
|
||||
````
|
||||
npm run test:curriculum
|
||||
pnpm run test:curriculum
|
||||
```
|
||||
|
||||
2. Puoi anche testare un blocco o un superblocco di sfide con questi comandi
|
||||
|
||||
```
|
||||
npm run test:curriculum --block='Basic HTML and HTML5'
|
||||
FCC_BLOCK='Basic HTML and HTML5' pnpm run test:curriculum
|
||||
```
|
||||
|
||||
```
|
||||
npm run test:curriculum --superblock=responsive-web-design
|
||||
FCC_SUPERBLOCK='responsive-web-design' pnpm run test:curriculum
|
||||
```
|
||||
|
||||
Puoi anche testare una sfida singola con i seguenti step:
|
||||
@@ -481,7 +481,7 @@ Puoi anche testare una sfida singola con i seguenti step:
|
||||
2. Esegui i seguenti comandi per ogni singolo file in cui hai fatto cambiamenti (rimpiazziando `challenge-title-goes-here` con il titolo intero della sfida):
|
||||
|
||||
```
|
||||
npm run test -- -g challenge-title-goes-here ```
|
||||
pnpm run test -- -g challenge-title-goes-here ```
|
||||
|
||||
Una volta che avrai verificato che ogni sfida su cui hai lavorato passi i test, [per favore crea una pull request](how-to-open-a-pull-request.md).
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ Queste istruzioni ti diranno come utilizzare il nostro strumento editor per le s
|
||||
|
||||
### Avviare l'editor
|
||||
|
||||
Per avviare l'editor, assicurati di essere nella cartella principale freeCodeCamp. Poi esegui `npm run challenge-editor` per avviare sia il client che l'API di cui fa uso l'editor.
|
||||
Per avviare l'editor, assicurati di essere nella cartella principale freeCodeCamp. Then, run `pnpm run challenge-editor` to start both the client and the API that powers the editor.
|
||||
|
||||
Il client verrà avviato sulla porta `3300`, così puoi accedervi su `http://localhost:3300`. L'API gira sulla porta `3200`, per evitare conflitti con il client learn e con il server. Questo ti permetterà di eseguire l'applicazione freeCodeCamp contemporaneamente all'editor, in modo che tu possa testare le tue modifiche localmente.
|
||||
|
||||
@@ -60,7 +60,7 @@ La cartella `tools/challenge-helper-scripts` contiene strumenti per aiutare a fa
|
||||
|
||||
### Creare un nuovo progetto
|
||||
|
||||
Esegui `npm run create-project` dalla cartella root. Questo apre un'interfaccia utente a linea di comando che ti guida attraverso il processo. Una volta finito, dovrebbe esserci una nuova sfida nel curriculum inglese che puoi usare come primo passo del progetto. Ad esempio, se hai creato un progetto chiamato `test-project` nella certificazione Web Design Responsivo, sarebbe in `curriculum/challenges/english/01-responsive-web-design/test-project`.
|
||||
Run `pnpm run create-project` from the root directory. Questo apre un'interfaccia utente a linea di comando che ti guida attraverso il processo. Una volta finito, dovrebbe esserci una nuova sfida nel curriculum inglese che puoi usare come primo passo del progetto. Ad esempio, se hai creato un progetto chiamato `test-project` nella certificazione Web Design Responsivo, sarebbe in `curriculum/challenges/english/01-responsive-web-design/test-project`.
|
||||
|
||||
Se vuoi creare nuovi step, i seguenti strumenti semplificano il processo.
|
||||
|
||||
@@ -71,10 +71,10 @@ Uno script una tantum che aggiungerà automaticamente lo step successivo in base
|
||||
#### Come eseguire lo script:
|
||||
|
||||
1. Vai alla directory del progetto.
|
||||
2. Esegui il seguente comando npm:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run create-next-step
|
||||
pnpm run create-next-step
|
||||
```
|
||||
|
||||
### create-empty-steps
|
||||
@@ -86,10 +86,10 @@ Uno script eseguito una sola volta che aggiunge automaticamente un determinato n
|
||||
#### Come eseguire lo script:
|
||||
|
||||
1. Vai alla directory del progetto.
|
||||
2. Esegui il seguente comando npm:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run create-empty-steps X # dove X è il numero di step da creare.
|
||||
pnpm run create-empty-steps X # where X is the number of steps to create.
|
||||
```
|
||||
|
||||
### insert-step
|
||||
@@ -101,10 +101,10 @@ Uno script una tantum che aggiunge automaticamente un nuovo step in una posizion
|
||||
#### Come eseguire lo script:
|
||||
|
||||
1. Vai alla directory del progetto.
|
||||
2. Esegui il seguente comando npm:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run insert-step X # dove X è la posizione in cui inserire il nuovo step.
|
||||
pnpm run insert-step X # where X is the position to insert the new step.
|
||||
```
|
||||
|
||||
### delete-step
|
||||
@@ -116,10 +116,10 @@ Uno script una tantum che rimuove uno step esistente, decrementando tutti gli st
|
||||
#### Come eseguire lo script
|
||||
|
||||
1. Vai alla directory del progetto.
|
||||
2. Esegui il seguente comando npm:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run delete-step num=x # dove x è il numero dello step da eliminare.
|
||||
pnpm run delete-step X # where X is the step number to be deleted.
|
||||
```
|
||||
|
||||
### update-step-titles
|
||||
@@ -129,8 +129,8 @@ Uno script una tantum che aggiorna automaticamente il frontmatter nei file di ma
|
||||
#### Come eseguire lo script
|
||||
|
||||
1. Vai alla directory del progetto.
|
||||
2. Esegui il seguente comando npm:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run update-step-titles
|
||||
pnpm run update-step-titles
|
||||
```
|
||||
|
||||
@@ -30,7 +30,7 @@ Un nuovo componente può essere creato usando i seguenti comandi dalla root dire
|
||||
```bash
|
||||
cd tools/ui-components
|
||||
|
||||
npm run gen-component MyComponent
|
||||
pnpm run gen-component MyComponent
|
||||
```
|
||||
|
||||
Il comando genererà una nuova cartella dentro la directory `ui-components`, con i seguenti file:
|
||||
@@ -76,7 +76,7 @@ Gli use case di un componente dovrebbero essere aggiunti al file Storybook (`.st
|
||||
Per far partire Storybook, esegui i seguenti comandi dalla directory root:
|
||||
|
||||
```bash
|
||||
npm run storybook
|
||||
pnpm run storybook
|
||||
```
|
||||
|
||||
La pagina Storybook è disponibile a [http://localhost:6006](http://localhost:6006).
|
||||
@@ -88,7 +88,7 @@ Usiamo [React Testing Library](https://testing-library.com/docs/react-testing-li
|
||||
Per eseguire i test sulla libreria componenti, esegui il seguente comando dalla directory root:
|
||||
|
||||
```bash
|
||||
npm run test-ui-components
|
||||
pnpm run test-ui-components
|
||||
```
|
||||
|
||||
## Aggiungere pacchetti alla libreria dei componenti UI
|
||||
@@ -96,7 +96,8 @@ npm run test-ui-components
|
||||
Limitiamo l'aggiunta di nuovi pacchetti ai Componenti UI per facilitare la manutenzione del progetto. Nel raro caso in cui pensi che sia necessaria una dipendenza, per favore, fai prima una verifica con i manutentori e quindi utilizza il seguente comando per aggiungere un pacchetto:
|
||||
|
||||
```bash
|
||||
npm i -w=tools/ui-components nome_pacchetto
|
||||
cd tools/ui-components
|
||||
pnpm add package_name
|
||||
```
|
||||
|
||||
### Link utili
|
||||
|
||||
@@ -50,13 +50,13 @@ Installa freeCodeCamp localmente ([vedi la guida di installazione locale](how-to
|
||||
#### Servire e avviare solo il sito di documentazione
|
||||
|
||||
```console
|
||||
npm run docs:serve
|
||||
pnpm run docs:serve
|
||||
```
|
||||
|
||||
#### Servire il sito di documentazione accanto a freeCodeCamp localmente:
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
> Il sito di documentazione dovrebbe essere disponibile su <http://localhost:3400>
|
||||
|
||||
@@ -17,10 +17,10 @@ Se sei su un sistema operativo diverso o continui ad avere dei problemi, visita
|
||||
Quando viene fatto il build del client, Gatsby memorizzerà nella cache i font, le stringhe di lingua e l'interfaccia utente. Se uno di loro non è memorizzato nella cache, esegui quanto segue:
|
||||
|
||||
```console
|
||||
npm run clean
|
||||
npm ci
|
||||
npm run seed
|
||||
npm run develop
|
||||
pnpm run clean
|
||||
pnpm install
|
||||
pnpm run seed
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
O
|
||||
@@ -28,7 +28,7 @@ O
|
||||
Usa la scorciatoia
|
||||
|
||||
```
|
||||
npm run clean-and-develop
|
||||
pnpm run clean-and-develop
|
||||
```
|
||||
|
||||
Se continui a incontrare problemi con il build, è consigliato ripulire lo spazio di lavoro.
|
||||
@@ -78,7 +78,7 @@ TCP 0.0.0.0:3000 DESKTOP LISTENING
|
||||
|
||||
Durante lo sviluppo, la sessione viene memorizzata come cookie. Cancellarli ti farà uscire dal tuo account di sviluppo.
|
||||
|
||||
Ti disconnetterai anche eseguendo `npm run seed:certified-user`. Sovrascriverà l'utente di sviluppo nel database locale.
|
||||
Running `pnpm run seed:certified-user` will log you out, too. Sovrascriverà l'utente di sviluppo nel database locale.
|
||||
|
||||
### Ottenere 404 navigando sulla pagina del profilo
|
||||
|
||||
|
||||
@@ -91,7 +91,7 @@
|
||||
4. リポジトリをローカルにビルドできることを確認します。
|
||||
|
||||
```
|
||||
npm run clean-and-develop
|
||||
pnpm run clean-and-develop
|
||||
```
|
||||
|
||||
5. 早送りマージにより、変更を `main` から `prod-staging` に移行します。
|
||||
@@ -453,13 +453,13 @@ sudo apt install build-essential
|
||||
6. 依存関係をインストールします。
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
7. サーバーを構築します。
|
||||
|
||||
```console
|
||||
npm run prebuild && npm run build:curriculum && npm run build:server
|
||||
pnpm run prebuild && pnpm run build:curriculum && pnpm run build:server
|
||||
```
|
||||
|
||||
8. インスタンスを開始します。
|
||||
@@ -496,13 +496,13 @@ pm2 stop all
|
||||
2. 依存関係をインストールします。
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
3. サーバーを構築します。
|
||||
|
||||
```console
|
||||
npm run create:config && npm run build:curriculum && npm run build:server
|
||||
pnpm run create:config && pnpm run build:curriculum && pnpm run build:server
|
||||
```
|
||||
|
||||
4. インスタンスを開始します。
|
||||
@@ -788,8 +788,8 @@ NGINX インスタンスへの設定変更は、GitHub 上でメンテナンス
|
||||
```console
|
||||
cd tools
|
||||
git pull origin master
|
||||
npm ci
|
||||
npm run build
|
||||
pnpm install
|
||||
pnpm run build
|
||||
pm2 restart contribute-app
|
||||
```
|
||||
|
||||
|
||||
@@ -27,25 +27,25 @@ Cypress テストもしくは「specs」の書き方については、Cypress
|
||||
- `./cypress` ディレクトリで、すべてのテストを実行します。
|
||||
|
||||
```console
|
||||
npm run cypress:dev:run
|
||||
pnpm run cypress:dev:run
|
||||
```
|
||||
|
||||
- 単一のテストを実行します。
|
||||
|
||||
```console
|
||||
npm run cypress -- run --spec=cypress/<path_to_test_file>
|
||||
pnpm run cypress -- run --spec=cypress/<path_to_test_file>
|
||||
```
|
||||
|
||||
For example:
|
||||
|
||||
```console
|
||||
npm run cypress -- run --spec=cypress/e2e/default/landing.js
|
||||
pnpm run cypress -- run --spec=cypress/e2e/default/landing.js
|
||||
```
|
||||
|
||||
- 開発ビルドを作成するには、開発サーバーを起動し、既存の cypress エンドツーエンドテストをすべて実行します。
|
||||
|
||||
```console
|
||||
npm run e2e:dev:run
|
||||
pnpm run e2e:dev:run
|
||||
```
|
||||
|
||||
## Cypress と GitPod の設定
|
||||
@@ -63,19 +63,19 @@ mongod
|
||||
- データベースをシードします。
|
||||
|
||||
```console
|
||||
npm run seed
|
||||
pnpm run seed
|
||||
```
|
||||
|
||||
- サーバーとクライアントを構築します。
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
### 2. Cypress ビルドツールをインストールする
|
||||
|
||||
```console
|
||||
npm run cypress:install-build-tools
|
||||
pnpm run cypress:install-build-tools
|
||||
```
|
||||
|
||||
- 端末でプロンプトが表示されたら、言語/エリアでキーボードのレイアウトを選択してください。
|
||||
|
||||
@@ -201,15 +201,15 @@ After you've committed your changes, check here for [how to open a Pull Request]
|
||||
|
||||
A quick reference to the commands that you will need when working.
|
||||
|
||||
| command | description |
|
||||
| -------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `npm test` | Run all JS tests in the system, including client, server, lint and challenge tests. |
|
||||
| `npm run test-client` | Run the client test suite. |
|
||||
| `npm run test:curriculum` | Run the curriculum test suite. |
|
||||
| `npm run test:curriculum --block='Basic HTML and HTML5'` | Test a specific Block. |
|
||||
| `npm run test:curriculum --superblock='responsive-web-design'` | Test a specific SuperBlock. |
|
||||
| `npm run test-curriculum-full-output` | Run the curriculum test suite, without bailing after the first error |
|
||||
| `npm run test-server` | Run the server test suite. |
|
||||
| `npm run e2e` | Run the Cypress end to end tests. |
|
||||
| `npm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
| `npm run storybook` | Starts Storybook for component library development. |
|
||||
| command | description |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `pnpm test` | Run all JS tests in the system, including client, server, lint and challenge tests. |
|
||||
| `pnpm run test-client` | Run the client test suite. |
|
||||
| `pnpm run test:curriculum` | Run the curriculum test suite. |
|
||||
| `FCC_BLOCK='Basic HTML and HTML5' pnpm run test:curriculum` | Test a specific Block. |
|
||||
| `FCC_SUPERBLOCK='responsive-web-design' pnpm run test:curriculum` | Test a specific SuperBlock. |
|
||||
| `pnpm run test-curriculum-full-output` | Run the curriculum test suite, without bailing after the first error |
|
||||
| `pnpm run test-server` | Run the server test suite. |
|
||||
| `pnpm run e2e` | Run the Cypress end to end tests. |
|
||||
| `pnpm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
| `pnpm run storybook` | Starts Storybook for component library development. |
|
||||
|
||||
@@ -293,9 +293,9 @@ Once you have the files, you will need to place them in the correct directory. F
|
||||
|
||||
Update your `.env` file to use your new language for `CLIENT_LOCALE` and `CURRICULUM_LOCALE`.
|
||||
|
||||
Once these are in place, you should be able to run `npm run develop` to view your translated version of freeCodeCamp.
|
||||
Once these are in place, you should be able to run `pnpm run develop` to view your translated version of freeCodeCamp.
|
||||
|
||||
> [!TIP] If you build the client in one language and then want to build it in a different language, you will need to use the command `npm run clean-and-develop` after changing the `.env` file, as Gatsby will cache the first language.
|
||||
> [!TIP] If you build the client in one language and then want to build it in a different language, you will need to use the command `pnpm run clean-and-develop` after changing the `.env` file, as Gatsby will cache the first language.
|
||||
|
||||
> [!ATTENTION] While you may perform translations locally for the purpose of testing, we remind everyone that translations should _not_ be submitted through GitHub and should only be done through Crowdin. Be sure to reset your local codebase after you are done testing.
|
||||
|
||||
|
||||
@@ -188,14 +188,14 @@ When you are working on features for our upcoming curriculum `next-*` branches,
|
||||
4. Resolve any conflicts, cleanup, install dependencies and run tests
|
||||
|
||||
```console
|
||||
npm run clean
|
||||
pnpm run clean
|
||||
|
||||
npm ci
|
||||
npm run test:curriculum --superblock=<superblock-name>
|
||||
pnpm install
|
||||
FCC_SUPERBLOCK='<superblock-name>' pnpm run test:curriculum
|
||||
|
||||
# example:
|
||||
|
||||
# npm run test:curriculum --superblock=python-for-everybody
|
||||
# FCC_SUPERBLOCK='python-for-everybody' pnpm run test:curriculum
|
||||
|
||||
```
|
||||
|
||||
|
||||
@@ -75,7 +75,7 @@ Some community members also develop on Windows natively with Git for Windows (Gi
|
||||
| 必要条件 | バージョン | 注 |
|
||||
| --------------------------------------------------------------------------------------- | ------- | ---------------------------------------------------------------------------------------- |
|
||||
| [Node.js](http://nodejs.org) | `18.x` | 「Active LTS」バージョンを使用しています。[LTS スケジュール](https://nodejs.org/en/about/releases/) を参照してください。 |
|
||||
| npm (Nodeにバンドル) | `8.x` | Node.js Active LTS にバンドルされたバージョンを使用します。 |
|
||||
| [pnpm](https://pnpm.io/installation) | `7.x` | - |
|
||||
| [MongoDB コミュニティサーバー](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.
|
||||
@@ -84,7 +84,7 @@ If Node.js is already installed on your machine, run the following commands to v
|
||||
|
||||
```console
|
||||
node -v
|
||||
npm -v
|
||||
pnpm -v
|
||||
```
|
||||
|
||||
> [!TIP] We highly recommend updating to the latest stable releases of the software listed above, also known as Long Term Support (LTS) releases.
|
||||
@@ -214,7 +214,7 @@ The keys in the `.env` file are _not_ required to be changed to run the app loca
|
||||
This step will install the dependencies required for the application to run:
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
#### ステップ 3: MongoDBを起動し、データベースをシードする
|
||||
@@ -252,7 +252,7 @@ Make sure to replace `3.6` with the version you have installed
|
||||
Next, let's seed the database. In this step, we run the below command that fills the MongoDB server with some initial data sets that are required by services. These include a few schemas, among other things.
|
||||
|
||||
```console
|
||||
npm run seed
|
||||
pnpm run seed
|
||||
```
|
||||
|
||||
#### ステップ 4: freeCodeCamp クライアントアプリケーションと API サーバーを起動する
|
||||
@@ -260,7 +260,7 @@ npm run seed
|
||||
You can now start up the API server and the client applications.
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
This single command will fire up all the services, including the API server and the client applications available for you to work on.
|
||||
@@ -271,7 +271,7 @@ The API serves endpoints at `http://localhost:3000`. The Gatsby app serves the c
|
||||
|
||||
While you are logged in, if you visit <http://localhost:3000/explorer> you should see the available APIs.
|
||||
|
||||
> [!WARNING] Clearing your cookies or running `npm run seed:certified-user` will log you out, and you will have to sign in again.
|
||||
> [!WARNING] Clearing your cookies or running `pnpm run seed:certified-user` will log you out, and you will have to sign in again.
|
||||
|
||||
If you have issues while installing it, check out the [troubleshooting section](troubleshooting-development-issues.md)
|
||||
|
||||
@@ -279,9 +279,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.
|
||||
|
||||
| コマンド | 説明 |
|
||||
| ----------------- | ------------------------------------------------------------ |
|
||||
| `npm ci` | すべての依存関係をインストール / 再インストールし、異なるサービスをブートストラップします。 |
|
||||
| `npm run seed` | Creates authorized test users and inserts them into mongodb. |
|
||||
| `npm run develop` | freeCodeCamp の API サーバーとクライアントアプリケーションを起動します。 |
|
||||
| `npm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
| コマンド | 説明 |
|
||||
| ------------------ | ------------------------------------------------------------ |
|
||||
| `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. |
|
||||
|
||||
@@ -12,4 +12,4 @@ Docker が正常に動作していることを確認したら、freeCodeCamp リ
|
||||
bash: change_volumes_owner.sh: No such file or directory
|
||||
```
|
||||
|
||||
`npm run docker:init` が原因である可能性があります。
|
||||
when you `pnpm run docker:init` this is likely the culprit.
|
||||
|
||||
@@ -457,17 +457,17 @@ function myFunc() {
|
||||
1. すべてのチャレンジをテストするには、ルートディレクトリから以下のコマンドを実行してください。
|
||||
|
||||
````
|
||||
npm run test:curriculum
|
||||
pnpm run test:curriculum
|
||||
```
|
||||
|
||||
2. 次のコマンドでチャレンジのブロックやスーパーブロックをテストすることもできます。
|
||||
|
||||
```
|
||||
npm run test:curriculum --block='Basic HTML and HTML5'
|
||||
FCC_BLOCK='Basic HTML and HTML5' pnpm run test:curriculum
|
||||
```
|
||||
|
||||
```
|
||||
npm run test:curriculum --superblock=responsive-web-design
|
||||
FCC_SUPERBLOCK='responsive-web-design' pnpm run test:curriculum
|
||||
```
|
||||
|
||||
次の手順を実行することで、1 つのチャレンジを個別にテストすることもできます。
|
||||
@@ -481,7 +481,7 @@ npm run test:curriculum --superblock=responsive-web-design
|
||||
2. 変更したチャレンジファイルごとに以下を実行します ( `challenge-title-goes-here` を正式なチャレンジのタイトルに置き換えてください)。
|
||||
|
||||
```
|
||||
npm run test -- -g challenge-title-goes-here ```
|
||||
pnpm run test -- -g challenge-title-goes-here ```
|
||||
|
||||
各チャレンジがテストに合格したことを確認したら、[プルリクエストを作成](how-to-open-a-pull-request.md) してください。
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ These instructions will tell you how to use our challenge editor tool to work on
|
||||
|
||||
### Starting the Editor
|
||||
|
||||
To start the editor, make sure you are in the root freecodecamp directory. Then, run `npm run challenge-editor` to start both the client and the API that powers the editor.
|
||||
To start the editor, make sure you are in the root freecodecamp directory. Then, run `pnpm run challenge-editor` to start both the client and the API that powers the editor.
|
||||
|
||||
The client will run on port `3300`, so you can access it at `http://localhost:3300`. The API runs on port `3200`, to avoid conflicts with the learn client and server. This will allow you to run the freeCodeCamp application at the same time as the editor, so you can test your changes locally.
|
||||
|
||||
@@ -60,7 +60,7 @@ The `tools/challenge-helper-scripts` folder contains tools to help facilitate th
|
||||
|
||||
### Create a new project
|
||||
|
||||
Run `npm run create-project` from the root directory. This opens up a command line ui that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/01-responsive-web-design/test-project`.
|
||||
Run `pnpm run create-project` from the root directory. This opens up a command line ui that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/01-responsive-web-design/test-project`.
|
||||
|
||||
If you want to create new steps, the following tools simplify that process.
|
||||
|
||||
@@ -71,10 +71,10 @@ A one-off script that will automatically add the next step based on the last ste
|
||||
#### How to run script:
|
||||
|
||||
1. プロジェクトのディレクトリに変更します。
|
||||
2. 以下の npm コマンドを実行します。
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run create-next-step
|
||||
pnpm run create-next-step
|
||||
```
|
||||
|
||||
### create-empty-steps
|
||||
@@ -86,10 +86,10 @@ A one-off script that automatically adds a specified number of steps. The challe
|
||||
#### How to run script:
|
||||
|
||||
1. プロジェクトのディレクトリに変更します。
|
||||
2. 以下の npm コマンドを実行します。
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run create-empty-steps X # where X is the number of steps to create.
|
||||
pnpm run create-empty-steps X # where X is the number of steps to create.
|
||||
```
|
||||
|
||||
### insert-step
|
||||
@@ -101,10 +101,10 @@ A one-off script that automatically adds a new step at a specified position, inc
|
||||
#### How to run script:
|
||||
|
||||
1. プロジェクトのディレクトリに変更します。
|
||||
2. 以下の npm コマンドを実行します。
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run insert-step X # where X is the position to insert the new step.
|
||||
pnpm run insert-step X # where X is the position to insert the new step.
|
||||
```
|
||||
|
||||
### delete-step
|
||||
@@ -116,10 +116,10 @@ A one-off script that deletes an existing step, decrementing all subsequent step
|
||||
#### How to run script
|
||||
|
||||
1. プロジェクトのディレクトリに変更します。
|
||||
2. 以下の npm コマンドを実行します。
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run delete-step X # where X is the step number to be deleted.
|
||||
pnpm run delete-step X # where X is the step number to be deleted.
|
||||
```
|
||||
|
||||
### update-step-titles
|
||||
@@ -129,8 +129,8 @@ A one-off script that automatically updates the frontmatter in a project's markd
|
||||
#### How to run script
|
||||
|
||||
1. プロジェクトのディレクトリに変更します。
|
||||
2. 以下の npm コマンドを実行します。
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run update-step-titles
|
||||
pnpm run update-step-titles
|
||||
```
|
||||
|
||||
@@ -30,7 +30,7 @@ A new component can be created using the following command from the root directo
|
||||
```bash
|
||||
cd tools/ui-components
|
||||
|
||||
npm run gen-component MyComponent
|
||||
pnpm run gen-component MyComponent
|
||||
```
|
||||
|
||||
The command will generate a new folder inside the `ui-components` directory, with the following files:
|
||||
@@ -76,7 +76,7 @@ Use cases of the component should be added to the Storybook file (`.stories.tsx`
|
||||
To start Storybook, run the following command from the root directory:
|
||||
|
||||
```bash
|
||||
npm run storybook
|
||||
pnpm run storybook
|
||||
```
|
||||
|
||||
The Storybook page is available on [http://localhost:6006](http://localhost:6006).
|
||||
@@ -88,7 +88,7 @@ We use [React Testing Library](https://testing-library.com/docs/react-testing-li
|
||||
To run tests against the component library, run the following command from the root directory:
|
||||
|
||||
```bash
|
||||
npm run test-ui-components
|
||||
pnpm run test-ui-components
|
||||
```
|
||||
|
||||
## Adding packages to the UI-Component library
|
||||
@@ -96,7 +96,8 @@ npm run test-ui-components
|
||||
We restrict adding new packages to the UI Components to help with the project's maintainability. In the rare chance that you think a dependency is needed, please check with the maintainers first and then use the following command to add a package:
|
||||
|
||||
```bash
|
||||
npm i -w=tools/ui-components package_name
|
||||
cd tools/ui-components
|
||||
pnpm add package_name
|
||||
```
|
||||
|
||||
### Useful links
|
||||
|
||||
@@ -50,13 +50,13 @@ Install freeCodeCamp locally ([see the local setup guide](how-to-setup-freecodec
|
||||
#### ドキュメントサイトのみを提供して起動する
|
||||
|
||||
```console
|
||||
npm run docs:serve
|
||||
pnpm run docs:serve
|
||||
```
|
||||
|
||||
#### freeCodeCamp と一緒にドキュメントサイトをローカルで提供する
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
> The documentation site should be available at <http://localhost:3400>
|
||||
|
||||
@@ -17,10 +17,10 @@ If you are on a different OS or are still facing issues, see [getting help](#get
|
||||
When you build the client, Gatsby will cache the Fonts, language strings and UI. If one of them isn't cached, run the following:
|
||||
|
||||
```console
|
||||
npm run clean
|
||||
npm ci
|
||||
npm run seed
|
||||
npm run develop
|
||||
pnpm run clean
|
||||
pnpm install
|
||||
pnpm run seed
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
OR
|
||||
@@ -28,7 +28,7 @@ OR
|
||||
Use the shortcut
|
||||
|
||||
```
|
||||
npm run clean-and-develop
|
||||
pnpm run clean-and-develop
|
||||
```
|
||||
|
||||
If you continue to face issues with the build, cleaning up the workspace is recommend.
|
||||
@@ -78,7 +78,7 @@ TCP 0.0.0.0:3000 DESKTOP LISTENING
|
||||
|
||||
While in development, your session is stored as cookies. Clearing them will sign you out of your development account.
|
||||
|
||||
Running `npm run seed:certified-user` will log you out, too. It will overwrite the development user in your local database.
|
||||
Running `pnpm run seed:certified-user` will log you out, too. It will overwrite the development user in your local database.
|
||||
|
||||
### Issue getting 404 when navigating profile page
|
||||
|
||||
|
||||
@@ -91,7 +91,7 @@ Atualmente, somente membros da equipe de desenvolvedores podem dar push nas bran
|
||||
4. Confirme se você consegue compilar o repositório localmente.
|
||||
|
||||
```
|
||||
npm run clean-and-develop
|
||||
pnpm run clean-and-develop
|
||||
```
|
||||
|
||||
5. Mova as alterações da `main` para a `production-staging` através de um fast-forward merge
|
||||
@@ -453,13 +453,13 @@ Provisionando MVs com o código
|
||||
6. Instale dependências
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
7. Compile o servidor
|
||||
|
||||
```console
|
||||
npm run prebuild && npm run build:curriculum && npm run build:server
|
||||
pnpm run prebuild && pnpm run build:curriculum && pnpm run build:server
|
||||
```
|
||||
|
||||
8. Inicie instâncias
|
||||
@@ -496,13 +496,13 @@ pm2 stop all
|
||||
2. Instale dependências
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
3. Compile o servidor
|
||||
|
||||
```console
|
||||
npm run create:config && npm run build:curriculum && npm run build:server
|
||||
pnpm run create:config && pnpm run build:curriculum && pnpm run build:server
|
||||
```
|
||||
|
||||
4. Inicie instâncias
|
||||
@@ -788,8 +788,8 @@ ssh na VM (hospedada na Digital Ocean).
|
||||
```console
|
||||
cd tools
|
||||
git pull origin master
|
||||
npm ci
|
||||
npm run build
|
||||
pnpm install
|
||||
pnpm run build
|
||||
pm2 restart contribute-app
|
||||
```
|
||||
|
||||
|
||||
@@ -27,25 +27,25 @@ Para executar testes usando compilações de produção, substitua `dev` por `pr
|
||||
- Para executar todos os testes no diretório `./cypress`:
|
||||
|
||||
```console
|
||||
npm run cypress:dev:run
|
||||
pnpm run cypress:dev:run
|
||||
```
|
||||
|
||||
- Para executar um único teste:
|
||||
|
||||
```console
|
||||
npm run cypress -- run --spec=cypress/<path_to_test_file>
|
||||
pnpm run cypress -- run --spec=cypress/<path_to_test_file>
|
||||
```
|
||||
|
||||
Por exemplo:
|
||||
|
||||
```console
|
||||
npm run cypress -- run --spec=cypress/e2e/default/landing.js
|
||||
pnpm run cypress -- run --spec=cypress/e2e/default/landing.js
|
||||
```
|
||||
|
||||
- Para criar uma versão de compilação, inicie o servidor de desenvolvimento e execute todos os testes cypress contínuos e funcionais existentes:
|
||||
|
||||
```console
|
||||
npm run e2e:dev:run
|
||||
pnpm run e2e:dev:run
|
||||
```
|
||||
|
||||
## Configuração do Cypress-GitPod
|
||||
@@ -63,19 +63,19 @@ mongod
|
||||
- Crie a base de dados
|
||||
|
||||
```console
|
||||
npm run seed
|
||||
pnpm run seed
|
||||
```
|
||||
|
||||
- Desenvolva o servidor e o client
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
### 2. Instale as ferramentas de compilação do Cypress
|
||||
|
||||
```console
|
||||
npm run cypress:install-build-tools
|
||||
pnpm run cypress:install-build-tools
|
||||
```
|
||||
|
||||
- Quando solicitado no terminal, selecione o layout do seu teclado por idioma/área
|
||||
|
||||
@@ -201,15 +201,15 @@ Após ter feito as alterações, veja [como abrir um Pull Request](how-to-open-a
|
||||
|
||||
Uma rápida referência aos comandos que você precisará ao trabalhar.
|
||||
|
||||
| comando | descrição |
|
||||
| -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `npm test` | Executa todos os testes JS no sistema, incluindo cliente, servidor, lint e testes dos desafios. |
|
||||
| `npm run test-client` | Executa o conjunto de testes do cliente. |
|
||||
| `npm run test:curriculum` | Executa o conjunto de teste de currículo. |
|
||||
| `npm run test:curriculum --block='Basic HTML and HTML5'` | Testa um bloco específico. |
|
||||
| `npm run test:curriculum --superblock='responsive-web-design'` | Testa um super bloco específico. |
|
||||
| `npm run test-curriculum-full-output` | Executa o ocnjunto de teste de currículo, sem parar após o primeiro erro |
|
||||
| `npm run test-server` | Executa o conjunto de testes de servidor. |
|
||||
| `npm run e2e` | Executa os testes de ponta a ponta do Cypress. |
|
||||
| `npm run clean` | Desinstala todas as dependências e limpa os caches. |
|
||||
| `npm run storybook` | Inicia o Storybook para o desenvolvimento da biblioteca de componentes. |
|
||||
| comando | descrição |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `pnpm test` | Executa todos os testes JS no sistema, incluindo cliente, servidor, lint e testes dos desafios. |
|
||||
| `pnpm run test-client` | Executa o conjunto de testes do cliente. |
|
||||
| `pnpm run test:curriculum` | Executa o conjunto de teste de currículo. |
|
||||
| `FCC_BLOCK='Basic HTML and HTML5' pnpm run test:curriculum` | Testa um bloco específico. |
|
||||
| `FCC_SUPERBLOCK='responsive-web-design' pnpm run test:curriculum` | Testa um super bloco específico. |
|
||||
| `pnpm run test-curriculum-full-output` | Executa o ocnjunto de teste de currículo, sem parar após o primeiro erro |
|
||||
| `pnpm run test-server` | Executa o conjunto de testes de servidor. |
|
||||
| `pnpm run e2e` | Executa os testes de ponta a ponta do Cypress. |
|
||||
| `pnpm run clean` | Desinstala todas as dependências e limpa os caches. |
|
||||
| `pnpm run storybook` | Inicia o Storybook para o desenvolvimento da biblioteca de componentes. |
|
||||
|
||||
@@ -293,9 +293,9 @@ Quando tiver os arquivos em mãos, você precisará colocá-los no diretório co
|
||||
|
||||
Atualize seu arquivo `.env` para usar seu novo idioma para `CLIENT_LOCALE` e `CURRICULUM_LOCALE`.
|
||||
|
||||
Quando estes arquivos estiverem no local certo, você deve poder usar `npm run develop` para ver sua versão traduzida do freeCodeCamp.
|
||||
Quando estes arquivos estiverem no local certo, você deve poder usar `pnpm run develop` para ver sua versão traduzida do freeCodeCamp.
|
||||
|
||||
> [!TIP] Se você fizer a build do client em um idioma e quiser fazer a build em um idioma diferente, precisará usar o comando `npm run clean-and-develop` depois de alterar o arquivo `.env`, pois o Gatsby armazenará em cache o primeiro idioma.
|
||||
> [!TIP] Se você fizer a build do client em um idioma e quiser fazer a build em um idioma diferente, precisará usar o comando `pnpm run clean-and-develop` depois de alterar o arquivo `.env`, pois o Gatsby armazenará em cache o primeiro idioma.
|
||||
|
||||
> [!ATTENTION] Embora você possa realizar as traduções localmente para fins de teste, lembramos a todos que as traduções _não_ devem ser enviadas pelo GitHub e devem ser feitas somente pelo Crowdin. Certifique-se de reiniciar sua base de código local após realizar os testes.
|
||||
|
||||
|
||||
@@ -188,14 +188,14 @@ Quando você estiver trabalhando em funcionalidades para nossos próximos branch
|
||||
4. Resolva os conflitos, faça a limpeza, instale as dependências e execute os testes
|
||||
|
||||
```console
|
||||
npm run clean
|
||||
pnpm run clean
|
||||
|
||||
npm ci
|
||||
npm run test:curriculum --superblock=<superblock-nome>
|
||||
pnpm install
|
||||
FCC_SUPERBLOCK='<superblock-name>' pnpm run test:curriculum
|
||||
|
||||
# exemplo:
|
||||
|
||||
# npm run test:curriculum --superblock=python-for-everybody
|
||||
# FCC_SUPERBLOCK='python-for-everybody' pnpm run test:curriculum
|
||||
|
||||
```
|
||||
|
||||
|
||||
@@ -75,7 +75,7 @@ Alguns membros da comunidade também desenvolvem no Windows nativamente com o Gi
|
||||
| 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/). |
|
||||
| npm (vem junto com o Node) | `8.x` | Usamos a versão que vem com o Node.js Active LTS. |
|
||||
| [pnpm](https://pnpm.io/installation) | `7.x` | - |
|
||||
| [Servidor da Comunidade MongoDB](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.
|
||||
@@ -84,7 +84,7 @@ Se o Node.js já estiver instalado em sua máquina, execute os comandos a seguir
|
||||
|
||||
```console
|
||||
node -v
|
||||
npm -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).
|
||||
@@ -214,7 +214,7 @@ As chaves no arquivo `.env` _ não _ precisam ser alteradas para executar o apli
|
||||
Esta etapa vai instalar as dependências necessárias para a execução do aplicativo:
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
#### Etapa 3: Iniciar o MongoDB e criar o banco de dados
|
||||
@@ -252,7 +252,7 @@ Certifique-se de substituir `3.6` pela versão que você instalou
|
||||
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.
|
||||
|
||||
```console
|
||||
npm run seed
|
||||
pnpm run seed
|
||||
```
|
||||
|
||||
#### Etapa 4: Iniciar o aplicativo client do freeCodeCamp e o servidor de API
|
||||
@@ -260,7 +260,7 @@ npm run seed
|
||||
Agora você pode iniciar o servidor de API e os aplicativos do client.
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
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.
|
||||
@@ -271,7 +271,7 @@ A API serve os endpoints em `http://localhost:3000`. O aplicativo Gatsby atende
|
||||
|
||||
Quando estiver conectado, se você visitar <http://localhost:3000/explorer> poderá ver as APIs disponíveis.
|
||||
|
||||
> [!WARNING] Limpar seus cookies ou executar `npm run seed:certified-user` desconectará você e será preciso fazer o login novamente.
|
||||
> [!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)
|
||||
|
||||
@@ -279,9 +279,9 @@ Se você tiver problemas durante a instalação, confira a [seção de solução
|
||||
|
||||
Uma rápida referência aos comandos que você precisará ao trabalhar localmente.
|
||||
|
||||
| comando | descrição |
|
||||
| ----------------- | ------------------------------------------------------------------------------ |
|
||||
| `npm ci` | Instala / reinstala todas as dependências e inicializa os diferentes serviços. |
|
||||
| `npm run seed` | Cria usuários de testes autorizados e os insere no mongodb. |
|
||||
| `npm run develop` | Inicia o servidor de API freeCodeCamp e aplicativos Cliente. |
|
||||
| `npm run clean` | Desinstala todas as dependências e limpa os caches. |
|
||||
| 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. |
|
||||
|
||||
@@ -12,4 +12,4 @@ Se você ver mensagens como
|
||||
bash: change_volumes_owner.sh: No such file or directory
|
||||
```
|
||||
|
||||
quando você usar `npm run docker:init`, esse é provavelmente o culpado.
|
||||
quando você usar `pnpm run docker:init`, esse é provavelmente o culpado.
|
||||
|
||||
@@ -460,17 +460,17 @@ Antes de [criar um pull request](how-to-open-a-pull-request.md) para suas modifi
|
||||
1. Para testar todos os desafios, execute o comando abaixo a partir do diretório raiz
|
||||
|
||||
````
|
||||
npm run test:curriculum
|
||||
pnpm run test:curriculum
|
||||
```
|
||||
|
||||
2. Você também pode testar um bloco ou superbloco de desafios com esses comandos
|
||||
|
||||
```
|
||||
npm run test:curriculum --block='Basic HTML and HTML5'
|
||||
FCC_BLOCK='Basic HTML and HTML5' pnpm run test:curriculum
|
||||
```
|
||||
|
||||
```
|
||||
npm run test:curriculum --superblock=responsive-web-design
|
||||
FCC_SUPERBLOCK='responsive-web-design' pnpm run test:curriculum
|
||||
```
|
||||
|
||||
Você também é capaz de testar um desafio individualmente seguindo as seguintes etapas:
|
||||
@@ -484,7 +484,7 @@ Você também é capaz de testar um desafio individualmente seguindo as seguinte
|
||||
2. Execute o comando a seguir para cada arquivo de desafio no qual você fez alteraçõess (substituindo `challenge-title-goes-here` com o título completo do desafio):
|
||||
|
||||
```
|
||||
npm run test -- -g challenge-title-goes-here ```
|
||||
pnpm run test -- -g challenge-title-goes-here ```
|
||||
|
||||
Quando você verificar que cada desafio modificado passou nos testes, [crie um pull request](how-to-open-a-pull-request.md).
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ Essas instruções informarão como usar a nossa ferramenta de edição de desaf
|
||||
|
||||
### Iniciando o editor
|
||||
|
||||
Para iniciar o editor, certifique-se de estar no diretório raiz do freecodecamp. Em seguida, execute `npm run challenge-editor` para iniciar tanto o client quanto a API que alimenta o editor.
|
||||
Para iniciar o editor, certifique-se de estar no diretório raiz do freecodecamp. Em seguida, execute `pnpm run challenge-editor` para iniciar tanto o client quanto a API que alimenta o editor.
|
||||
|
||||
O client será executado na porta `3300`, então você pode acessá-la em `http://localhost:3300`. A API é executada na porta `3200`, para evitar conflitos com o client de aprendizagem e com o servidor. Isso permitirá que você execute o aplicativo do freeCodeCamp ao mesmo tempo que o editor, para poder testar as alterações localmente.
|
||||
|
||||
@@ -60,7 +60,7 @@ A pasta `tools/challenge-helper-scripts` contém ferramentas para ajudar a facil
|
||||
|
||||
### Criando um projeto
|
||||
|
||||
Execute `npm run create-project` no diretório raiz. Esse comando abrirá uma interface de linha de comando que vai guiar você através do processo. Uma vez que tiver terminado, deverá aparecer um novo desafio no currículo em inglês que você pode usar para começar o projeto. Por exemplo, se você tiver criado um projeto chamado `test-project` na certificação de Design responsivo para a web, ele estará em `curriculum/challenges/english/01-responsive-web-design/test-project`.
|
||||
Execute `pnpm run create-project` no diretório raiz. Esse comando abrirá uma interface de linha de comando que vai guiar você através do processo. Uma vez que tiver terminado, deverá aparecer um novo desafio no currículo em inglês que você pode usar para começar o projeto. Por exemplo, se você tiver criado um projeto chamado `test-project` na certificação de Design responsivo para a web, ele estará em `curriculum/challenges/english/01-responsive-web-design/test-project`.
|
||||
|
||||
Se você quer criar outros passos, as ferramentas a seguir vão simplificar o processo.
|
||||
|
||||
@@ -71,10 +71,10 @@ Um script único que adicionará automaticamente o próximo passo com base no ú
|
||||
#### Como executar esse script:
|
||||
|
||||
1. Mude para o diretório do projeto.
|
||||
2. Execute o comando npm a seguir:
|
||||
2. Execute o comando a seguir:
|
||||
|
||||
```bash
|
||||
npm run create-next-step
|
||||
pnpm run create-next-step
|
||||
```
|
||||
|
||||
### create-empty-steps
|
||||
@@ -86,10 +86,10 @@ Um script único que adiciona automaticamente um número específico de passos.
|
||||
#### Como executar esse script:
|
||||
|
||||
1. Mude para o diretório do projeto.
|
||||
2. Execute o comando npm a seguir:
|
||||
2. Execute o comando a seguir:
|
||||
|
||||
```bash
|
||||
npm run create-empty-steps X #, onde X é o número de etapas a serem criadas.
|
||||
pnpm run create-empty-steps X #, onde X é o número de etapas a serem criadas.
|
||||
```
|
||||
|
||||
### insert-step
|
||||
@@ -101,10 +101,10 @@ Um script único que adiciona automaticamente um novo passo em uma posição esp
|
||||
#### Como executar esse script:
|
||||
|
||||
1. Mude para o diretório do projeto.
|
||||
2. Execute o comando npm a seguir:
|
||||
2. Execute o comando a seguir:
|
||||
|
||||
```bash
|
||||
npm run insert-step X #, onde X é a posição para inserir a nova etapa.
|
||||
pnpm run insert-step X #, onde X é a posição para inserir a nova etapa.
|
||||
```
|
||||
|
||||
### delete-step
|
||||
@@ -116,10 +116,10 @@ Um script único que exclui um passo existente e decrementa todos os passos post
|
||||
#### Como executar esse script
|
||||
|
||||
1. Mude para o diretório do projeto.
|
||||
2. Execute o comando npm a seguir:
|
||||
2. Execute o comando a seguir:
|
||||
|
||||
```bash
|
||||
npm run delete-step X #, onde X é o número do passo a ser excluído.
|
||||
pnpm run delete-step X #, onde X é o número do passo a ser excluído.
|
||||
```
|
||||
|
||||
### update-step-titles
|
||||
@@ -129,8 +129,8 @@ Um script único que atualiza automaticamente a frontmatter nos arquivos markdow
|
||||
#### Como executar esse script
|
||||
|
||||
1. Mude para o diretório do projeto.
|
||||
2. Execute o comando npm a seguir:
|
||||
2. Execute o comando a seguir:
|
||||
|
||||
```bash
|
||||
npm run update-step-titles
|
||||
pnpm run update-step-titles
|
||||
```
|
||||
|
||||
@@ -30,7 +30,7 @@ Um novo componente pode ser criado usando o seguinte comando a partir do diretó
|
||||
```bash
|
||||
cd tools/ui-components
|
||||
|
||||
npm run gen-component MyComponent
|
||||
pnpm run gen-component MyComponent
|
||||
```
|
||||
|
||||
O comando gerará uma nova pasta dentro do diretório `ui-components`, com os seguintes arquivos:
|
||||
@@ -76,7 +76,7 @@ Os casos de uso do componente devem ser adicionados ao arquivo Storybook (`.stor
|
||||
Para iniciar o Storybook, execute o seguinte comando a partir do diretório raiz:
|
||||
|
||||
```bash
|
||||
npm run storybook
|
||||
pnpm run storybook
|
||||
```
|
||||
|
||||
A página do Storybook está disponível em [http://localhost:6006](http://localhost:6006).
|
||||
@@ -88,7 +88,7 @@ Usamos a [React Testing Library](https://testing-library.com/docs/react-testing-
|
||||
Para executar testes contra a biblioteca de componentes, execute o seguinte comando a partir do diretório raiz:
|
||||
|
||||
```bash
|
||||
npm run test-ui-components
|
||||
pnpm run test-ui-components
|
||||
```
|
||||
|
||||
## Adicionar pacotes à biblioteca de componentes da UI
|
||||
@@ -96,7 +96,8 @@ npm run test-ui-components
|
||||
Restringimos a adição de novos pacotes aos componentes da UI para ajudar com a manutenção do projeto. Na hipótese de você achar que uma dependência é necessária, consulte os gestores primeiro e use o seguinte comando para adicionar um pacote:
|
||||
|
||||
```bash
|
||||
npm i -w=tools/ui-components package_name
|
||||
cd tools/ui-components
|
||||
pnpm add package_name
|
||||
```
|
||||
|
||||
### Links úteis
|
||||
|
||||
@@ -50,13 +50,13 @@ Instale o freeCodeCamp localmente ([veja o guia de instalação local](how-to-se
|
||||
#### Veicule e inicie apenas o site da documentação
|
||||
|
||||
```console
|
||||
npm run docs:serve
|
||||
pnpm run docs:serve
|
||||
```
|
||||
|
||||
#### Veicule localmente o site da documentação juntamente com o freeCodeCamp:
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
> O site da documentação deve estar disponível em <http://localhost:3400>
|
||||
|
||||
@@ -17,10 +17,10 @@ Se você está em um sistema operacional diferente ou se ainda está encontrando
|
||||
Quando você fizer a build no client, o Gatsby armazenará em cache as fontes, as strings de idioma e a interface do usuário. Se um deles não estiver em cache, execute o seguinte:
|
||||
|
||||
```console
|
||||
npm run clean
|
||||
npm ci
|
||||
npm run seed
|
||||
npm run develop
|
||||
pnpm run clean
|
||||
pnpm install
|
||||
pnpm run seed
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
OU
|
||||
@@ -28,7 +28,7 @@ OU
|
||||
Use o atalho
|
||||
|
||||
```
|
||||
npm run clean-and-develop
|
||||
pnpm run clean-and-develop
|
||||
```
|
||||
|
||||
Se você continua enfrentando problemas com a compilação, é recomendável limpar o espaço de trabalho.
|
||||
@@ -78,7 +78,7 @@ TCP 0.0.0.0:3000 DESKTOP LISTENING
|
||||
|
||||
Enquanto estiver em desenvolvimento, sua sessão é armazenada como cookies. Limpar os cookies os retirará de sua conta de desenvolvimento.
|
||||
|
||||
Executar `npm run seed:certified-user` também deslogará você. Isso sobrescreverá o usuário de desenvolvimento em seu banco de dados local.
|
||||
Executar `pnpm run seed:certified-user` também deslogará você. Isso sobrescreverá o usuário de desenvolvimento em seu banco de dados local.
|
||||
|
||||
### Problema de obter 404 ao navegar na página de perfil
|
||||
|
||||
|
||||
@@ -91,7 +91,7 @@ Currently, only members on the developer team can push to the production branche
|
||||
4. Confirm that you are able to build the repository locally.
|
||||
|
||||
```
|
||||
npm run clean-and-develop
|
||||
pnpm run clean-and-develop
|
||||
```
|
||||
|
||||
5. Move changes from `main` to `prod-staging` via a fast-forward merge
|
||||
@@ -453,13 +453,13 @@ Provisioning VMs with the Code
|
||||
6. Install dependencies
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
7. Build the server
|
||||
|
||||
```console
|
||||
npm run prebuild && npm run build:curriculum && npm run build:server
|
||||
pnpm run prebuild && pnpm run build:curriculum && pnpm run build:server
|
||||
```
|
||||
|
||||
8. Start Instances
|
||||
@@ -496,13 +496,13 @@ pm2 stop all
|
||||
2. Install dependencies
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
3. Build the server
|
||||
|
||||
```console
|
||||
npm run create:config && npm run build:curriculum && npm run build:server
|
||||
pnpm run create:config && pnpm run build:curriculum && pnpm run build:server
|
||||
```
|
||||
|
||||
4. Start Instances
|
||||
@@ -788,8 +788,8 @@ ssh into the VM (hosted on Digital Ocean).
|
||||
```console
|
||||
cd tools
|
||||
git pull origin master
|
||||
npm ci
|
||||
npm run build
|
||||
pnpm install
|
||||
pnpm run build
|
||||
pm2 restart contribute-app
|
||||
```
|
||||
|
||||
|
||||
@@ -27,25 +27,25 @@
|
||||
- Щоб запустити всі тести у директорії `./cypress`:
|
||||
|
||||
```console
|
||||
npm run cypress:dev:run
|
||||
pnpm run cypress:dev:run
|
||||
```
|
||||
|
||||
- Для запуску одного тесту:
|
||||
|
||||
```console
|
||||
npm run cypress -- run --spec=cypress/<path_to_test_file>
|
||||
pnpm run cypress -- run --spec=cypress/<path_to_test_file>
|
||||
```
|
||||
|
||||
Наприклад:
|
||||
|
||||
```console
|
||||
npm run cypress -- run --spec=cypress/e2e/default/landing.js
|
||||
pnpm run cypress -- run --spec=cypress/e2e/default/landing.js
|
||||
```
|
||||
|
||||
- Щоб створити збірку розробки, запустіть сервер розробки і виконайте всі наявні тести cypress:
|
||||
|
||||
```console
|
||||
npm run e2e:dev:run
|
||||
pnpm run e2e:dev:run
|
||||
```
|
||||
|
||||
## Налаштування Cypress-GitPod
|
||||
@@ -63,19 +63,19 @@ mongod
|
||||
- Заповніть базу даних
|
||||
|
||||
```console
|
||||
npm run seed
|
||||
pnpm run seed
|
||||
```
|
||||
|
||||
- Розробіть сервер та клієнта
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
### 2. Встановіть інструменти збірки Cypress
|
||||
|
||||
```console
|
||||
npm run cypress:install-build-tools
|
||||
pnpm run cypress:install-build-tools
|
||||
```
|
||||
|
||||
- Якщо керований в терміналі, виберіть розкладку клавіатури за мовою/регіоном
|
||||
|
||||
@@ -201,15 +201,15 @@ After you've committed your changes, check here for [how to open a Pull Request]
|
||||
|
||||
A quick reference to the commands that you will need when working.
|
||||
|
||||
| команда | опис |
|
||||
| -------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `npm test` | Run all JS tests in the system, including client, server, lint and challenge tests. |
|
||||
| `npm run test-client` | Run the client test suite. |
|
||||
| `npm run test:curriculum` | Run the curriculum test suite. |
|
||||
| `npm run test:curriculum --block='Basic HTML and HTML5'` | Test a specific Block. |
|
||||
| `npm run test:curriculum --superblock='responsive-web-design'` | Test a specific SuperBlock. |
|
||||
| `npm run test-curriculum-full-output` | Run the curriculum test suite, without bailing after the first error |
|
||||
| `npm run test-server` | Run the server test suite. |
|
||||
| `npm run e2e` | Run the Cypress end to end tests. |
|
||||
| `npm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
| `npm run storybook` | Starts Storybook for component library development. |
|
||||
| команда | опис |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `pnpm test` | Run all JS tests in the system, including client, server, lint and challenge tests. |
|
||||
| `pnpm run test-client` | Run the client test suite. |
|
||||
| `pnpm run test:curriculum` | Run the curriculum test suite. |
|
||||
| `FCC_BLOCK='Basic HTML and HTML5' pnpm run test:curriculum` | Test a specific Block. |
|
||||
| `FCC_SUPERBLOCK='responsive-web-design' pnpm run test:curriculum` | Test a specific SuperBlock. |
|
||||
| `pnpm run test-curriculum-full-output` | Run the curriculum test suite, without bailing after the first error |
|
||||
| `pnpm run test-server` | Run the server test suite. |
|
||||
| `pnpm run e2e` | Run the Cypress end to end tests. |
|
||||
| `pnpm run clean` | Uninstalls all dependencies and cleans up caches. |
|
||||
| `pnpm run storybook` | Starts Storybook for component library development. |
|
||||
|
||||
@@ -293,9 +293,9 @@ Once you have the files, you will need to place them in the correct directory. F
|
||||
|
||||
Update your `.env` file to use your new language for `CLIENT_LOCALE` and `CURRICULUM_LOCALE`.
|
||||
|
||||
Once these are in place, you should be able to run `npm run develop` to view your translated version of freeCodeCamp.
|
||||
Once these are in place, you should be able to run `pnpm run develop` to view your translated version of freeCodeCamp.
|
||||
|
||||
> [!TIP] If you build the client in one language and then want to build it in a different language, you will need to use the command `npm run clean-and-develop` after changing the `.env` file, as Gatsby will cache the first language.
|
||||
> [!TIP] If you build the client in one language and then want to build it in a different language, you will need to use the command `pnpm run clean-and-develop` after changing the `.env` file, as Gatsby will cache the first language.
|
||||
|
||||
> [!ATTENTION] While you may perform translations locally for the purpose of testing, we remind everyone that translations should _not_ be submitted through GitHub and should only be done through Crowdin. Be sure to reset your local codebase after you are done testing.
|
||||
|
||||
|
||||
@@ -188,14 +188,14 @@ When you are working on features for our upcoming curriculum `next-*` branches,
|
||||
4. Resolve any conflicts, cleanup, install dependencies and run tests
|
||||
|
||||
```console
|
||||
npm run clean
|
||||
pnpm run clean
|
||||
|
||||
npm ci
|
||||
npm run test:curriculum --superblock=<superblock-name>
|
||||
pnpm install
|
||||
FCC_SUPERBLOCK='<superblock-name>' pnpm run test:curriculum
|
||||
|
||||
# приклад:
|
||||
# example:
|
||||
|
||||
# npm run test:curriculum --superblock=python-for-everybody
|
||||
# FCC_SUPERBLOCK='python-for-everybody' pnpm run test:curriculum
|
||||
|
||||
```
|
||||
|
||||
|
||||
@@ -75,7 +75,7 @@ Some community members also develop on Windows natively with Git for Windows (Gi
|
||||
| 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/). |
|
||||
| npm (comes bundled with Node) | `8.x` | We use the version bundled with Node.js Active LTS. |
|
||||
| [pnpm](https://pnpm.io/installation) | `7.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.
|
||||
@@ -84,7 +84,7 @@ If Node.js is already installed on your machine, run the following commands to v
|
||||
|
||||
```console
|
||||
node -v
|
||||
npm -v
|
||||
pnpm -v
|
||||
```
|
||||
|
||||
> [!TIP] We highly recommend updating to the latest stable releases of the software listed above, also known as Long Term Support (LTS) releases.
|
||||
@@ -214,7 +214,7 @@ The keys in the `.env` file are _not_ required to be changed to run the app loca
|
||||
This step will install the dependencies required for the application to run:
|
||||
|
||||
```console
|
||||
npm ci
|
||||
pnpm install
|
||||
```
|
||||
|
||||
#### Step 3: Start MongoDB and seed the database
|
||||
@@ -252,7 +252,7 @@ Make sure to replace `3.6` with the version you have installed
|
||||
Next, let's seed the database. In this step, we run the below command that fills the MongoDB server with some initial data sets that are required by services. These include a few schemas, among other things.
|
||||
|
||||
```console
|
||||
npm run seed
|
||||
pnpm run seed
|
||||
```
|
||||
|
||||
#### Step 4: Start the freeCodeCamp client application and API server
|
||||
@@ -260,7 +260,7 @@ npm run seed
|
||||
You can now start up the API server and the client applications.
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
This single command will fire up all the services, including the API server and the client applications available for you to work on.
|
||||
@@ -271,7 +271,7 @@ The API serves endpoints at `http://localhost:3000`. The Gatsby app serves the c
|
||||
|
||||
While you are logged in, if you visit <http://localhost:3000/explorer> you should see the available APIs.
|
||||
|
||||
> [!WARNING] Clearing your cookies or running `npm run seed:certified-user` will log you out, and you will have to sign in again.
|
||||
> [!WARNING] Clearing your cookies or running `pnpm run seed:certified-user` will log you out, and you will have to sign in again.
|
||||
|
||||
If you have issues while installing it, check out the [troubleshooting section](troubleshooting-development-issues.md)
|
||||
|
||||
@@ -279,9 +279,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.
|
||||
|
||||
| command | description |
|
||||
| ----------------- | ----------------------------------------------------------------------------- |
|
||||
| `npm ci` | Installs / re-install all dependencies and bootstraps the different services. |
|
||||
| `npm run seed` | Creates authorized test users and inserts them into mongodb. |
|
||||
| `npm run develop` | Starts the freeCodeCamp API Server and Client Applications. |
|
||||
| `npm 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. |
|
||||
|
||||
@@ -12,4 +12,4 @@
|
||||
bash: change_volumes_owner.sh: No such file or directory
|
||||
```
|
||||
|
||||
коли `npm run docker:init` це, ймовірно, злам.
|
||||
when you `pnpm run docker:init` this is likely the culprit.
|
||||
|
||||
@@ -457,17 +457,17 @@ Before you [create a pull request](how-to-open-a-pull-request.md) for your chang
|
||||
1. To test all challenges run the below command from the root directory
|
||||
|
||||
````
|
||||
npm run test:curriculum
|
||||
pnpm run test:curriculum
|
||||
```
|
||||
|
||||
2. You can also test a block or a superblock of challenges with these commands
|
||||
|
||||
```
|
||||
npm run test:curriculum --block='Basic HTML and HTML5'
|
||||
FCC_BLOCK='Basic HTML and HTML5' pnpm run test:curriculum
|
||||
```
|
||||
|
||||
```
|
||||
npm run test:curriculum --superblock=responsive-web-design
|
||||
FCC_SUPERBLOCK='responsive-web-design' pnpm run test:curriculum
|
||||
```
|
||||
|
||||
You are also able to test one challenge individually by performing the following steps:
|
||||
@@ -481,7 +481,7 @@ You are also able to test one challenge individually by performing the following
|
||||
2. Run the following for each challenge file for which you have changed (replacing `challenge-title-goes-here` with the full title of the challenge):
|
||||
|
||||
```
|
||||
npm run test -- -g challenge-title-goes-here ```
|
||||
pnpm run test -- -g challenge-title-goes-here ```
|
||||
|
||||
Once you have verified that each challenge you've worked on passes the tests, [please create a pull request](how-to-open-a-pull-request.md).
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ These instructions will tell you how to use our challenge editor tool to work on
|
||||
|
||||
### Starting the Editor
|
||||
|
||||
To start the editor, make sure you are in the root freecodecamp directory. Then, run `npm run challenge-editor` to start both the client and the API that powers the editor.
|
||||
To start the editor, make sure you are in the root freecodecamp directory. Then, run `pnpm run challenge-editor` to start both the client and the API that powers the editor.
|
||||
|
||||
The client will run on port `3300`, so you can access it at `http://localhost:3300`. The API runs on port `3200`, to avoid conflicts with the learn client and server. This will allow you to run the freeCodeCamp application at the same time as the editor, so you can test your changes locally.
|
||||
|
||||
@@ -60,7 +60,7 @@ The `tools/challenge-helper-scripts` folder contains tools to help facilitate th
|
||||
|
||||
### Create a new project
|
||||
|
||||
Run `npm run create-project` from the root directory. This opens up a command line ui that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/01-responsive-web-design/test-project`.
|
||||
Run `pnpm run create-project` from the root directory. This opens up a command line ui that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/01-responsive-web-design/test-project`.
|
||||
|
||||
If you want to create new steps, the following tools simplify that process.
|
||||
|
||||
@@ -71,10 +71,10 @@ A one-off script that will automatically add the next step based on the last ste
|
||||
#### How to run script:
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run create-next-step
|
||||
pnpm run create-next-step
|
||||
```
|
||||
|
||||
### create-empty-steps
|
||||
@@ -86,10 +86,10 @@ A one-off script that automatically adds a specified number of steps. The challe
|
||||
#### How to run script:
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run create-empty-steps X # where X is the number of steps to create.
|
||||
pnpm run create-empty-steps X # where X is the number of steps to create.
|
||||
```
|
||||
|
||||
### insert-step
|
||||
@@ -101,10 +101,10 @@ A one-off script that automatically adds a new step at a specified position, inc
|
||||
#### How to run script:
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run insert-step X # where X is the position to insert the new step.
|
||||
pnpm run insert-step X # where X is the position to insert the new step.
|
||||
```
|
||||
|
||||
### delete-step
|
||||
@@ -116,10 +116,10 @@ A one-off script that deletes an existing step, decrementing all subsequent step
|
||||
#### How to run script
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run delete-step X # where X is the step number to be deleted.
|
||||
pnpm run delete-step X # where X is the step number to be deleted.
|
||||
```
|
||||
|
||||
### update-step-titles
|
||||
@@ -129,8 +129,8 @@ A one-off script that automatically updates the frontmatter in a project's markd
|
||||
#### How to run script
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
2. Run the following command:
|
||||
|
||||
```bash
|
||||
npm run update-step-titles
|
||||
pnpm run update-step-titles
|
||||
```
|
||||
|
||||
@@ -30,7 +30,7 @@ A new component can be created using the following command from the root directo
|
||||
```bash
|
||||
cd tools/ui-components
|
||||
|
||||
npm run gen-component MyComponent
|
||||
pnpm run gen-component MyComponent
|
||||
```
|
||||
|
||||
The command will generate a new folder inside the `ui-components` directory, with the following files:
|
||||
@@ -76,7 +76,7 @@ Use cases of the component should be added to the Storybook file (`.stories.tsx`
|
||||
To start Storybook, run the following command from the root directory:
|
||||
|
||||
```bash
|
||||
npm run storybook
|
||||
pnpm run storybook
|
||||
```
|
||||
|
||||
The Storybook page is available on [http://localhost:6006](http://localhost:6006).
|
||||
@@ -88,7 +88,7 @@ We use [React Testing Library](https://testing-library.com/docs/react-testing-li
|
||||
To run tests against the component library, run the following command from the root directory:
|
||||
|
||||
```bash
|
||||
npm run test-ui-components
|
||||
pnpm run test-ui-components
|
||||
```
|
||||
|
||||
## Adding packages to the UI-Component library
|
||||
@@ -96,7 +96,8 @@ npm run test-ui-components
|
||||
We restrict adding new packages to the UI Components to help with the project's maintainability. In the rare chance that you think a dependency is needed, please check with the maintainers first and then use the following command to add a package:
|
||||
|
||||
```bash
|
||||
npm i -w=tools/ui-components package_name
|
||||
cd tools/ui-components
|
||||
pnpm add package_name
|
||||
```
|
||||
|
||||
### Useful links
|
||||
|
||||
@@ -50,13 +50,13 @@ Install freeCodeCamp locally ([see the local setup guide](how-to-setup-freecodec
|
||||
#### Обслужити та запустити лише документаційний сайт
|
||||
|
||||
```console
|
||||
npm run docs:serve
|
||||
pnpm run docs:serve
|
||||
```
|
||||
|
||||
#### Обслужити документаційний сайт поряд з freeCodeCamp локально:
|
||||
|
||||
```console
|
||||
npm run develop
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
> Сайт документації повинен бути доступним на <http://localhost:3400>
|
||||
|
||||
@@ -17,10 +17,10 @@ If you are on a different OS or are still facing issues, see [getting help](#get
|
||||
When you build the client, Gatsby will cache the Fonts, language strings and UI. If one of them isn't cached, run the following:
|
||||
|
||||
```console
|
||||
npm run clean
|
||||
npm ci
|
||||
npm run seed
|
||||
npm run develop
|
||||
pnpm run clean
|
||||
pnpm install
|
||||
pnpm run seed
|
||||
pnpm run develop
|
||||
```
|
||||
|
||||
OR
|
||||
@@ -28,7 +28,7 @@ OR
|
||||
Use the shortcut
|
||||
|
||||
```
|
||||
npm run clean-and-develop
|
||||
pnpm run clean-and-develop
|
||||
```
|
||||
|
||||
If you continue to face issues with the build, cleaning up the workspace is recommend.
|
||||
@@ -78,7 +78,7 @@ TCP 0.0.0.0:3000 DESKTOP LISTENING
|
||||
|
||||
While in development, your session is stored as cookies. Clearing them will sign you out of your development account.
|
||||
|
||||
Running `npm run seed:certified-user` will log you out, too. It will overwrite the development user in your local database.
|
||||
Running `pnpm run seed:certified-user` will log you out, too. It will overwrite the development user in your local database.
|
||||
|
||||
### Issue getting 404 when navigating profile page
|
||||
|
||||
|
||||
Reference in New Issue
Block a user