mirror of
https://github.com/freeCodeCamp/freeCodeCamp.git
synced 2026-01-06 06:01:31 -05:00
chore(i18n,docs): processed translations (#47049)
This commit is contained in:
camperbot
@@ -1,18 +1,74 @@
|
||||
# How to Work on Practice Projects
|
||||
|
||||
Our practice projects use a step-based approach to teach concepts to campers. A project will consist of multiple files, which we refer to as **"steps"**. These files are named by the challenge ID, to avoid issues with the translation flow. Unfortunately, this makes it difficult to find the file associated with a specific step.
|
||||
|
||||
We've built a challenge editor tool that helps remedy this. This tool allows you to navigate the available projects, and the steps for each project (in order). There's also an embedded code editor you can use to work on the files directly.
|
||||
|
||||
## Using the Challenge Editor
|
||||
|
||||
These instructions will tell you how to use our challenge editor tool to work on the practice projects.
|
||||
|
||||
### 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.
|
||||
|
||||
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.
|
||||
|
||||
### Navigating the Editor
|
||||
|
||||
The default view will list the available `superblocks` - these are the certifications. Click on the certification link you want to work on.
|
||||
|
||||
This will take you to the list of blocks. These are the practice projects. Click on the project link you want to work on.
|
||||
|
||||
This will take you to a list of steps for the project. If you are working on an existing step, you can click on the step link to open the editor. If you are adding or removing steps, click the `Use the step tools` link to switch to the step tools for that challenge.
|
||||
|
||||
### Editing Steps
|
||||
|
||||
When you click on a step, you'll be taken to the editor. This is a basic text editor that offers syntax highlighting.
|
||||
|
||||
After you have made your changes, click the `Save Changes` button to save your changes. You will get a browser alert letting you know that your changes are ready to commit. Note that you'll need to use `git` manually to stage and commit your files - this tool will not do that for you.
|
||||
|
||||
### Step Tools
|
||||
|
||||
When you click the `Use the step tools` link, you'll be taken to the step tools page. This allows you to add or remove steps from the project.
|
||||
|
||||
#### Create Next Step
|
||||
|
||||
Clicking this button will add a new step at the end of the project. This step will use the previous step's code as the seed.
|
||||
|
||||
#### Create Empty Steps
|
||||
|
||||
Enter the number of steps you want to add in the input. Then, clicking the button will create that many empty steps at the end of the project.
|
||||
|
||||
#### Insert Step
|
||||
|
||||
Enter the step number that you want to add a step _after_. For example, if you want to add a step after `step-12`, enter `12`. Then, click the `Insert Step` button to add the step. The following steps will be re-ordered.
|
||||
|
||||
#### Delete Step
|
||||
|
||||
Enter the step number you want to delete. Then click the `Delete Step` button to remove that step. This will automatically update the step numbers for the remaining steps.
|
||||
|
||||
#### Update Step Titles
|
||||
|
||||
You should not have to use this tool unless you've manually deleted or added steps. This tool will reorder the step numbers.
|
||||
|
||||
## Using the Scripts Manually
|
||||
|
||||
If you want to work on the steps manually, in your local IDE, you can run the step management scripts directly.
|
||||
|
||||
The `tools/challenge-helper-scripts` folder contains tools to help facilitate the creation and maintenance of the freeCodeCamp project-based curriculum.
|
||||
|
||||
## Create a new project
|
||||
### Create a new project
|
||||
|
||||
Run `npm run create-project`. 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 `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`.
|
||||
|
||||
If you want to create new steps, the following tools simplify that process.
|
||||
|
||||
## create-next-step
|
||||
### create-next-step
|
||||
|
||||
A one-off script that will automatically add the next step based on the last step in the project. The challenge seed code will use the previous step's challenge seed code.
|
||||
|
||||
### How to run script:
|
||||
#### How to run script:
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
@@ -21,13 +77,13 @@ A one-off script that will automatically add the next step based on the last ste
|
||||
npm run create-next-step
|
||||
```
|
||||
|
||||
## create-empty-steps
|
||||
### create-empty-steps
|
||||
|
||||
A one-off script that automatically adds a specified number of steps. The challenge seed code for all steps created will be empty.
|
||||
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### How to run script:
|
||||
#### How to run script:
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
@@ -36,13 +92,13 @@ A one-off script that automatically adds a specified number of steps. The challe
|
||||
npm run create-empty-steps X # where X is the number of steps to create.
|
||||
```
|
||||
|
||||
## insert-step
|
||||
### insert-step
|
||||
|
||||
A one-off script that automatically adds a new step at a specified position, incrementing all subsequent steps (both their titles and in their meta.json). The challenge seed code will use the previous step's challenge seed code with the editable region markers (ERMs) removed.
|
||||
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### How to run script:
|
||||
#### How to run script:
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
@@ -51,13 +107,13 @@ A one-off script that automatically adds a new step at a specified position, inc
|
||||
npm run insert-step X # where X is the position to insert the new step.
|
||||
```
|
||||
|
||||
## delete-step
|
||||
### delete-step
|
||||
|
||||
A one-off script that deletes an existing step, decrementing all subsequent steps (both their titles and in their meta.json)
|
||||
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### How to run script
|
||||
#### How to run script
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
@@ -66,11 +122,11 @@ A one-off script that deletes an existing step, decrementing all subsequent step
|
||||
npm run delete-step X # where X is the step number to be deleted.
|
||||
```
|
||||
|
||||
## update-step-titles
|
||||
### update-step-titles
|
||||
|
||||
A one-off script that automatically updates the frontmatter in a project's markdown files so that they are consistent with the project's meta.json. It ensures that each step's title (and dashedName) match the meta's challengeOrder.
|
||||
|
||||
### How to run script
|
||||
#### How to run script
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
|
||||
@@ -1,18 +1,74 @@
|
||||
# How to Work on Practice Projects
|
||||
|
||||
Our practice projects use a step-based approach to teach concepts to campers. A project will consist of multiple files, which we refer to as **"steps"**. These files are named by the challenge ID, to avoid issues with the translation flow. Unfortunately, this makes it difficult to find the file associated with a specific step.
|
||||
|
||||
We've built a challenge editor tool that helps remedy this. This tool allows you to navigate the available projects, and the steps for each project (in order). There's also an embedded code editor you can use to work on the files directly.
|
||||
|
||||
## Using the Challenge Editor
|
||||
|
||||
These instructions will tell you how to use our challenge editor tool to work on the practice projects.
|
||||
|
||||
### 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.
|
||||
|
||||
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.
|
||||
|
||||
### Navigating the Editor
|
||||
|
||||
The default view will list the available `superblocks` - these are the certifications. Click on the certification link you want to work on.
|
||||
|
||||
This will take you to the list of blocks. These are the practice projects. Click on the project link you want to work on.
|
||||
|
||||
This will take you to a list of steps for the project. If you are working on an existing step, you can click on the step link to open the editor. If you are adding or removing steps, click the `Use the step tools` link to switch to the step tools for that challenge.
|
||||
|
||||
### Editing Steps
|
||||
|
||||
When you click on a step, you'll be taken to the editor. This is a basic text editor that offers syntax highlighting.
|
||||
|
||||
After you have made your changes, click the `Save Changes` button to save your changes. You will get a browser alert letting you know that your changes are ready to commit. Note that you'll need to use `git` manually to stage and commit your files - this tool will not do that for you.
|
||||
|
||||
### Step Tools
|
||||
|
||||
When you click the `Use the step tools` link, you'll be taken to the step tools page. This allows you to add or remove steps from the project.
|
||||
|
||||
#### Create Next Step
|
||||
|
||||
Clicking this button will add a new step at the end of the project. This step will use the previous step's code as the seed.
|
||||
|
||||
#### Create Empty Steps
|
||||
|
||||
Enter the number of steps you want to add in the input. Then, clicking the button will create that many empty steps at the end of the project.
|
||||
|
||||
#### Insert Step
|
||||
|
||||
Enter the step number that you want to add a step _after_. For example, if you want to add a step after `step-12`, enter `12`. Then, click the `Insert Step` button to add the step. The following steps will be re-ordered.
|
||||
|
||||
#### Delete Step
|
||||
|
||||
Enter the step number you want to delete. Then click the `Delete Step` button to remove that step. This will automatically update the step numbers for the remaining steps.
|
||||
|
||||
#### Update Step Titles
|
||||
|
||||
You should not have to use this tool unless you've manually deleted or added steps. This tool will reorder the step numbers.
|
||||
|
||||
## Using the Scripts Manually
|
||||
|
||||
If you want to work on the steps manually, in your local IDE, you can run the step management scripts directly.
|
||||
|
||||
The `tools/challenge-helper-scripts` folder contains tools to help facilitate the creation and maintenance of the freeCodeCamp project-based curriculum.
|
||||
|
||||
## Create a new project
|
||||
### Create a new project
|
||||
|
||||
Run `npm run create-project`. 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 `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`.
|
||||
|
||||
If you want to create new steps, the following tools simplify that process.
|
||||
|
||||
## create-next-step
|
||||
### create-next-step
|
||||
|
||||
A one-off script that will automatically add the next step based on the last step in the project. The challenge seed code will use the previous step's challenge seed code.
|
||||
|
||||
### How to run script:
|
||||
#### How to run script:
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
@@ -21,13 +77,13 @@ A one-off script that will automatically add the next step based on the last ste
|
||||
npm run create-next-step
|
||||
```
|
||||
|
||||
## create-empty-steps
|
||||
### create-empty-steps
|
||||
|
||||
A one-off script that automatically adds a specified number of steps. The challenge seed code for all steps created will be empty.
|
||||
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### How to run script:
|
||||
#### How to run script:
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
@@ -36,13 +92,13 @@ A one-off script that automatically adds a specified number of steps. The challe
|
||||
npm run create-empty-steps X # where X is the number of steps to create.
|
||||
```
|
||||
|
||||
## insert-step
|
||||
### insert-step
|
||||
|
||||
A one-off script that automatically adds a new step at a specified position, incrementing all subsequent steps (both their titles and in their meta.json). The challenge seed code will use the previous step's challenge seed code with the editable region markers (ERMs) removed.
|
||||
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### How to run script:
|
||||
#### How to run script:
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
@@ -51,13 +107,13 @@ A one-off script that automatically adds a new step at a specified position, inc
|
||||
npm run insert-step X # where X is the position to insert the new step.
|
||||
```
|
||||
|
||||
## delete-step
|
||||
### delete-step
|
||||
|
||||
A one-off script that deletes an existing step, decrementing all subsequent steps (both their titles and in their meta.json)
|
||||
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### How to run script
|
||||
#### How to run script
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
@@ -66,11 +122,11 @@ A one-off script that deletes an existing step, decrementing all subsequent step
|
||||
npm run delete-step X # where X is the step number to be deleted.
|
||||
```
|
||||
|
||||
## update-step-titles
|
||||
### update-step-titles
|
||||
|
||||
A one-off script that automatically updates the frontmatter in a project's markdown files so that they are consistent with the project's meta.json. It ensures that each step's title (and dashedName) match the meta's challengeOrder.
|
||||
|
||||
### How to run script
|
||||
#### How to run script
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
|
||||
@@ -1,18 +1,74 @@
|
||||
# Cómo Trabajar en Proyectos de Práctica
|
||||
|
||||
La carpeta `tools/challenge-helper-scripts` contiene herramientas para facilitar la creación y mantenimiento del plan de estudio basado en proyectos de FreeCodeCamp.
|
||||
Our practice projects use a step-based approach to teach concepts to campers. A project will consist of multiple files, which we refer to as **"steps"**. These files are named by the challenge ID, to avoid issues with the translation flow. Unfortunately, this makes it difficult to find the file associated with a specific step.
|
||||
|
||||
## Crea un nuevo proyecto
|
||||
We've built a challenge editor tool that helps remedy this. This tool allows you to navigate the available projects, and the steps for each project (in order). There's also an embedded code editor you can use to work on the files directly.
|
||||
|
||||
Ejecuta el comando `npm run create-project`. Esto muestra una consola que te guiará durante el proceso. Una vez terminado, debería haber un nuevo desafío en el plan de estudio de Ingles que puedes utilizar para el primer paso del proyecto. Por ejemplo, si creaste un proyecto llamado `test-project` en la certificación de Diseño Web Responsivo, esté debería estar en `curriculum/challenges/english/01-responsive-web-design/test-project`.
|
||||
## Using the Challenge Editor
|
||||
|
||||
Si deseas crear nuevos pasos, las siguientes herramientas simplifican este proceso.
|
||||
These instructions will tell you how to use our challenge editor tool to work on the practice projects.
|
||||
|
||||
## Crea el siguiente paso
|
||||
### Starting the Editor
|
||||
|
||||
Un script único que automáticamente agregará el siguiente paso basado en el último paso del proyecto. El código de semilla de desafío utilizará el código de semilla de desafío del paso anterior.
|
||||
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.
|
||||
|
||||
### Cómo ejecutar un script:
|
||||
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.
|
||||
|
||||
### Navigating the Editor
|
||||
|
||||
The default view will list the available `superblocks` - these are the certifications. Click on the certification link you want to work on.
|
||||
|
||||
This will take you to the list of blocks. These are the practice projects. Click on the project link you want to work on.
|
||||
|
||||
This will take you to a list of steps for the project. If you are working on an existing step, you can click on the step link to open the editor. If you are adding or removing steps, click the `Use the step tools` link to switch to the step tools for that challenge.
|
||||
|
||||
### Editing Steps
|
||||
|
||||
When you click on a step, you'll be taken to the editor. This is a basic text editor that offers syntax highlighting.
|
||||
|
||||
After you have made your changes, click the `Save Changes` button to save your changes. You will get a browser alert letting you know that your changes are ready to commit. Note that you'll need to use `git` manually to stage and commit your files - this tool will not do that for you.
|
||||
|
||||
### Step Tools
|
||||
|
||||
When you click the `Use the step tools` link, you'll be taken to the step tools page. This allows you to add or remove steps from the project.
|
||||
|
||||
#### Create Next Step
|
||||
|
||||
Clicking this button will add a new step at the end of the project. This step will use the previous step's code as the seed.
|
||||
|
||||
#### Create Empty Steps
|
||||
|
||||
Enter the number of steps you want to add in the input. Then, clicking the button will create that many empty steps at the end of the project.
|
||||
|
||||
#### Insert Step
|
||||
|
||||
Enter the step number that you want to add a step _after_. For example, if you want to add a step after `step-12`, enter `12`. Then, click the `Insert Step` button to add the step. The following steps will be re-ordered.
|
||||
|
||||
#### Delete Step
|
||||
|
||||
Enter the step number you want to delete. Then click the `Delete Step` button to remove that step. This will automatically update the step numbers for the remaining steps.
|
||||
|
||||
#### Update Step Titles
|
||||
|
||||
You should not have to use this tool unless you've manually deleted or added steps. This tool will reorder the step numbers.
|
||||
|
||||
## Using the Scripts Manually
|
||||
|
||||
If you want to work on the steps manually, in your local IDE, you can run the step management scripts directly.
|
||||
|
||||
The `tools/challenge-helper-scripts` folder contains tools to help facilitate the creation and maintenance of the freeCodeCamp project-based curriculum.
|
||||
|
||||
### 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`.
|
||||
|
||||
If you want to create new steps, the following tools simplify that process.
|
||||
|
||||
### create-next-step
|
||||
|
||||
A one-off script that will automatically add the next step based on the last step in the project. The challenge seed code will use the previous step's challenge seed code.
|
||||
|
||||
#### How to run script:
|
||||
|
||||
1. Redirígete al directorio del proyecto.
|
||||
2. Ejecuta el siguiente comando npm:
|
||||
@@ -21,13 +77,13 @@ Un script único que automáticamente agregará el siguiente paso basado en el
|
||||
Ejecuta npm crear siguiente paso
|
||||
```
|
||||
|
||||
## Crea pasos vacíos
|
||||
### create-empty-steps
|
||||
|
||||
Un script único que agrega automáticamente un número determinado de pasos. El código para todos los pasos creados estará vacío.
|
||||
A one-off script that automatically adds a specified number of steps. The challenge seed code for all steps created will be empty.
|
||||
|
||||
**Nota:** Este script también ejecuta [reorder-steps](#update-step-titles).
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### Cómo ejecutar un script:
|
||||
#### How to run script:
|
||||
|
||||
1. Redirígete al directorio del proyecto.
|
||||
2. Ejecuta el siguiente comando npm:
|
||||
@@ -36,13 +92,13 @@ Un script único que agrega automáticamente un número determinado de pasos. El
|
||||
npm run create-empty-steps X # donde X es el número de pasos a crear.
|
||||
```
|
||||
|
||||
## insert-step
|
||||
### insert-step
|
||||
|
||||
Un script único que agrega automáticamente un nuevo paso en una posición especificada, incrementando todos los pasos posteriores (tanto sus títulos como en su meta.json). El código principal del desafío, utilizará el código de los desafíos de pasos anteriores, con los marcadores de región editables (ERM) eliminados.
|
||||
A one-off script that automatically adds a new step at a specified position, incrementing all subsequent steps (both their titles and in their meta.json). The challenge seed code will use the previous step's challenge seed code with the editable region markers (ERMs) removed.
|
||||
|
||||
**Nota:** Este script también ejecuta [reorder-steps](#update-step-titles).
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### Cómo ejecutar el script:
|
||||
#### How to run script:
|
||||
|
||||
1. Redirígete al directorio principal del proyecto.
|
||||
2. Ejecuta el siguiente comando npm:
|
||||
@@ -51,13 +107,13 @@ Un script único que agrega automáticamente un nuevo paso en una posición espe
|
||||
npm run insert-step X # donde X es la posición para insertar el nuevo paso.
|
||||
```
|
||||
|
||||
## Eliminar un paso
|
||||
### delete-step
|
||||
|
||||
Un script único que elimina un paso existente, decrementando todos los pasos posteriores (tanto sus títulos como en su meta.json)
|
||||
A one-off script that deletes an existing step, decrementing all subsequent steps (both their titles and in their meta.json)
|
||||
|
||||
**Nota:** Este script también ejecuta [reorder-steps](#update-step-titles).
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### Cómo ejecutar el script
|
||||
#### How to run script
|
||||
|
||||
1. Redirígete al directorio principal del proyecto.
|
||||
2. Ejecuta el siguiente comando npm:
|
||||
@@ -66,11 +122,11 @@ Un script único que elimina un paso existente, decrementando todos los pasos po
|
||||
npm ejecuta delete-step X # donde X es el número de paso a ser eliminado.
|
||||
```
|
||||
|
||||
## update-step-titles
|
||||
### update-step-titles
|
||||
|
||||
Un script único que actualiza automáticamente la materia frontal en los archivos markdown de un proyecto para que sean consistentes con el meta.json del proyecto. Garantiza que el título de cada paso (y dashedName) coincida con el challengeOrder del meta.
|
||||
A one-off script that automatically updates the frontmatter in a project's markdown files so that they are consistent with the project's meta.json. It ensures that each step's title (and dashedName) match the meta's challengeOrder.
|
||||
|
||||
### Cómo ejecutar un script
|
||||
#### How to run script
|
||||
|
||||
1. Redirígete al directorio del proyecto.
|
||||
2. Ejecuta el siguiente comando npm:
|
||||
|
||||
@@ -1,18 +1,74 @@
|
||||
# Wie man an Praxisprojekten arbeitet
|
||||
|
||||
Der Ordner `tools/challenge-helper-scripts` enthält Tools, die die Erstellung und Pflege des projektbasierten Studienplans von freeCodeCamp erleichtern.
|
||||
Our practice projects use a step-based approach to teach concepts to campers. A project will consist of multiple files, which we refer to as **"steps"**. These files are named by the challenge ID, to avoid issues with the translation flow. Unfortunately, this makes it difficult to find the file associated with a specific step.
|
||||
|
||||
## Erstelle ein neues Projekt
|
||||
We've built a challenge editor tool that helps remedy this. This tool allows you to navigate the available projects, and the steps for each project (in order). There's also an embedded code editor you can use to work on the files directly.
|
||||
|
||||
Führe `npm run create-project` aus. Dadurch öffnet sich eine Kommandozeilenoberfläche, die dich durch den Prozess führt. Wenn das erledigt ist, sollte es eine neue Aufgabe im englischen Studienplan geben, die du für den ersten Schritt des Projekts nutzen kannst. Wenn du zum Beispiel ein Projekt mit dem Namen `test-project` in der Responsive-Webdesign-Zertifizierung erstellt hast, befindet es sich in `curriculum/challenges/english/01-responsive-web-design/test-project`.
|
||||
## Using the Challenge Editor
|
||||
|
||||
Wenn du neue Schritte erstellen willst, vereinfachen die folgenden Tools diesen Prozess.
|
||||
These instructions will tell you how to use our challenge editor tool to work on the practice projects.
|
||||
|
||||
## Nächsten Schritt erstellen
|
||||
### Starting the Editor
|
||||
|
||||
Ein einmaliges Skript, das automatisch den nächsten Schritt basierend auf dem letzten Schritt des Projekts hinzufügt. Der Aufgaben-Startcode verwendet den Startcode aus der vorherigen Aufgabe.
|
||||
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.
|
||||
|
||||
### So führst du das Skript aus:
|
||||
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.
|
||||
|
||||
### Navigating the Editor
|
||||
|
||||
The default view will list the available `superblocks` - these are the certifications. Click on the certification link you want to work on.
|
||||
|
||||
This will take you to the list of blocks. These are the practice projects. Click on the project link you want to work on.
|
||||
|
||||
This will take you to a list of steps for the project. If you are working on an existing step, you can click on the step link to open the editor. If you are adding or removing steps, click the `Use the step tools` link to switch to the step tools for that challenge.
|
||||
|
||||
### Editing Steps
|
||||
|
||||
When you click on a step, you'll be taken to the editor. This is a basic text editor that offers syntax highlighting.
|
||||
|
||||
After you have made your changes, click the `Save Changes` button to save your changes. You will get a browser alert letting you know that your changes are ready to commit. Note that you'll need to use `git` manually to stage and commit your files - this tool will not do that for you.
|
||||
|
||||
### Step Tools
|
||||
|
||||
When you click the `Use the step tools` link, you'll be taken to the step tools page. This allows you to add or remove steps from the project.
|
||||
|
||||
#### Create Next Step
|
||||
|
||||
Clicking this button will add a new step at the end of the project. This step will use the previous step's code as the seed.
|
||||
|
||||
#### Create Empty Steps
|
||||
|
||||
Enter the number of steps you want to add in the input. Then, clicking the button will create that many empty steps at the end of the project.
|
||||
|
||||
#### Insert Step
|
||||
|
||||
Enter the step number that you want to add a step _after_. For example, if you want to add a step after `step-12`, enter `12`. Then, click the `Insert Step` button to add the step. The following steps will be re-ordered.
|
||||
|
||||
#### Delete Step
|
||||
|
||||
Enter the step number you want to delete. Then click the `Delete Step` button to remove that step. This will automatically update the step numbers for the remaining steps.
|
||||
|
||||
#### Update Step Titles
|
||||
|
||||
You should not have to use this tool unless you've manually deleted or added steps. This tool will reorder the step numbers.
|
||||
|
||||
## Using the Scripts Manually
|
||||
|
||||
If you want to work on the steps manually, in your local IDE, you can run the step management scripts directly.
|
||||
|
||||
The `tools/challenge-helper-scripts` folder contains tools to help facilitate the creation and maintenance of the freeCodeCamp project-based curriculum.
|
||||
|
||||
### 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`.
|
||||
|
||||
If you want to create new steps, the following tools simplify that process.
|
||||
|
||||
### create-next-step
|
||||
|
||||
A one-off script that will automatically add the next step based on the last step in the project. The challenge seed code will use the previous step's challenge seed code.
|
||||
|
||||
#### How to run script:
|
||||
|
||||
1. Wechsle in das Verzeichnis des Projekts.
|
||||
2. Führe den folgenden npm-Befehl aus:
|
||||
@@ -21,13 +77,13 @@ Ein einmaliges Skript, das automatisch den nächsten Schritt basierend auf dem l
|
||||
npm run create-next-step
|
||||
```
|
||||
|
||||
## leere Schritte erstellen
|
||||
### create-empty-steps
|
||||
|
||||
Ein einmaliges Skript, das automatisch eine bestimmte Anzahl von Schritten hinzufügt. Der Aufgaben-Seed-Code für alle erstellten Schritte wird leer sein.
|
||||
A one-off script that automatically adds a specified number of steps. The challenge seed code for all steps created will be empty.
|
||||
|
||||
**Hinweis:** Dieses Skript führt auch [update-step-titles](#update-step-titles) aus.
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### So führst du das Skript aus:
|
||||
#### How to run script:
|
||||
|
||||
1. Wechsle in das Verzeichnis des Projekts.
|
||||
2. Führe den folgenden npm-Befehl aus:
|
||||
@@ -36,13 +92,13 @@ Ein einmaliges Skript, das automatisch eine bestimmte Anzahl von Schritten hinzu
|
||||
npm run create-empty-steps X # wobei X die Anzahl der zu erstellenden Schritte ist.
|
||||
```
|
||||
|
||||
## insert-step
|
||||
### insert-step
|
||||
|
||||
Ein Einmal-Skript, das automatisch einen neuen Schritt an einer bestimmten Stelle hinzufügt und alle nachfolgenden Schritte (sowohl ihre Titel als auch in ihrem meta.json) erhöht. Der Aufgaben-Seed-Code (initialer Startcode im Editor) verwendet den Aufgaben-Seed-Code des vorherigen Schritts, wobei die Editable Region Markers (ERMs) entfernt werden.
|
||||
A one-off script that automatically adds a new step at a specified position, incrementing all subsequent steps (both their titles and in their meta.json). The challenge seed code will use the previous step's challenge seed code with the editable region markers (ERMs) removed.
|
||||
|
||||
**Hinweis:** Dieses Skript führt auch [update-step-titles](#update-step-titles) aus.
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### So führst du das Skript aus:
|
||||
#### How to run script:
|
||||
|
||||
1. Wechsle in das Verzeichnis des Projekts.
|
||||
2. Führe den folgenden npm-Befehl aus:
|
||||
@@ -51,13 +107,13 @@ Ein Einmal-Skript, das automatisch einen neuen Schritt an einer bestimmten Stell
|
||||
npm run insert-step X # wobei X die Position ist, an der der neue Schritt eingefügt werden soll.
|
||||
```
|
||||
|
||||
## Lösche eine Schritt
|
||||
### delete-step
|
||||
|
||||
Ein einmaliges Skript, das einen bestehenden Schritt löscht und alle nachfolgenden Schritte dekrementiert (sowohl ihre Titel als auch in ihrer meta.json)
|
||||
A one-off script that deletes an existing step, decrementing all subsequent steps (both their titles and in their meta.json)
|
||||
|
||||
**Hinweis:** Dieses Skript führt auch [update-step-titles](#update-step-titles) aus.
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### So führst du das Skript aus
|
||||
#### How to run script
|
||||
|
||||
1. Wechsle in das Verzeichnis des Projekts.
|
||||
2. Führe den folgenden npm-Befehl aus:
|
||||
@@ -66,11 +122,11 @@ Ein einmaliges Skript, das einen bestehenden Schritt löscht und alle nachfolgen
|
||||
npm run delete-step X # wobei X die Schrittnummer ist, die gelöscht werden soll.
|
||||
```
|
||||
|
||||
## update-step-titles
|
||||
### update-step-titles
|
||||
|
||||
Ein einmaliges Skript, das automatisch die Frontmatter in den Markdown-Dateien eines Projekts aktualisiert, damit sie mit der meta.json des Projekts übereinstimmen. Es stellt sicher, dass der Titel (und der dashedName) jedes Schritts mit der challengeOrder des Metas übereinstimmt.
|
||||
A one-off script that automatically updates the frontmatter in a project's markdown files so that they are consistent with the project's meta.json. It ensures that each step's title (and dashedName) match the meta's challengeOrder.
|
||||
|
||||
### Wie man das Skript ausführt
|
||||
#### How to run script
|
||||
|
||||
1. Wechsle in das Verzeichnis des Projekts.
|
||||
2. Führe den folgenden npm-Befehl aus:
|
||||
|
||||
@@ -1,18 +1,74 @@
|
||||
# Come lavorare sui progetti di pratica
|
||||
|
||||
La cartella `tools/challenge-helper-scripts` contiene strumenti per aiutare a facilitare la creazione e il mantenimento del curriculum basato su progetti di freeCodeCamp.
|
||||
Our practice projects use a step-based approach to teach concepts to campers. A project will consist of multiple files, which we refer to as **"steps"**. These files are named by the challenge ID, to avoid issues with the translation flow. Unfortunately, this makes it difficult to find the file associated with a specific step.
|
||||
|
||||
## Creare un nuovo progetto
|
||||
We've built a challenge editor tool that helps remedy this. This tool allows you to navigate the available projects, and the steps for each project (in order). There's also an embedded code editor you can use to work on the files directly.
|
||||
|
||||
Esegui `npm run create-project`. 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`.
|
||||
## Using the Challenge Editor
|
||||
|
||||
Se vuoi creare nuovi passi, i seguenti strumenti semplificano quel processo.
|
||||
These instructions will tell you how to use our challenge editor tool to work on the practice projects.
|
||||
|
||||
## create-next-step
|
||||
### Starting the Editor
|
||||
|
||||
Uno script una tantum che aggiungerà automaticamente il passo successivo in base all'ultimo passo del progetto. Il codice seed della sfida userà il codice seed di quella precedente.
|
||||
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.
|
||||
|
||||
### Come eseguire lo script:
|
||||
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.
|
||||
|
||||
### Navigating the Editor
|
||||
|
||||
The default view will list the available `superblocks` - these are the certifications. Click on the certification link you want to work on.
|
||||
|
||||
This will take you to the list of blocks. These are the practice projects. Click on the project link you want to work on.
|
||||
|
||||
This will take you to a list of steps for the project. If you are working on an existing step, you can click on the step link to open the editor. If you are adding or removing steps, click the `Use the step tools` link to switch to the step tools for that challenge.
|
||||
|
||||
### Editing Steps
|
||||
|
||||
When you click on a step, you'll be taken to the editor. This is a basic text editor that offers syntax highlighting.
|
||||
|
||||
After you have made your changes, click the `Save Changes` button to save your changes. You will get a browser alert letting you know that your changes are ready to commit. Note that you'll need to use `git` manually to stage and commit your files - this tool will not do that for you.
|
||||
|
||||
### Step Tools
|
||||
|
||||
When you click the `Use the step tools` link, you'll be taken to the step tools page. This allows you to add or remove steps from the project.
|
||||
|
||||
#### Create Next Step
|
||||
|
||||
Clicking this button will add a new step at the end of the project. This step will use the previous step's code as the seed.
|
||||
|
||||
#### Create Empty Steps
|
||||
|
||||
Enter the number of steps you want to add in the input. Then, clicking the button will create that many empty steps at the end of the project.
|
||||
|
||||
#### Insert Step
|
||||
|
||||
Enter the step number that you want to add a step _after_. For example, if you want to add a step after `step-12`, enter `12`. Then, click the `Insert Step` button to add the step. The following steps will be re-ordered.
|
||||
|
||||
#### Delete Step
|
||||
|
||||
Enter the step number you want to delete. Then click the `Delete Step` button to remove that step. This will automatically update the step numbers for the remaining steps.
|
||||
|
||||
#### Update Step Titles
|
||||
|
||||
You should not have to use this tool unless you've manually deleted or added steps. This tool will reorder the step numbers.
|
||||
|
||||
## Using the Scripts Manually
|
||||
|
||||
If you want to work on the steps manually, in your local IDE, you can run the step management scripts directly.
|
||||
|
||||
The `tools/challenge-helper-scripts` folder contains tools to help facilitate the creation and maintenance of the freeCodeCamp project-based curriculum.
|
||||
|
||||
### 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`.
|
||||
|
||||
If you want to create new steps, the following tools simplify that process.
|
||||
|
||||
### create-next-step
|
||||
|
||||
A one-off script that will automatically add the next step based on the last step in the project. The challenge seed code will use the previous step's challenge seed code.
|
||||
|
||||
#### How to run script:
|
||||
|
||||
1. Vai alla directory del progetto.
|
||||
2. Esegui il seguente comando npm:
|
||||
@@ -21,13 +77,13 @@ Uno script una tantum che aggiungerà automaticamente il passo successivo in bas
|
||||
npm run create-next-step
|
||||
```
|
||||
|
||||
## create-empty-steps
|
||||
### create-empty-steps
|
||||
|
||||
Uno script eseguito una sola volta che aggiunge automaticamente un determinato numero di step. Il codice seed della sfida per tutti i passi creati sarà vuoto.
|
||||
A one-off script that automatically adds a specified number of steps. The challenge seed code for all steps created will be empty.
|
||||
|
||||
**Nota:** Questo script esegue anche [update-step-titles](#update-step-titles).
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### Come eseguire lo script:
|
||||
#### How to run script:
|
||||
|
||||
1. Vai alla directory del progetto.
|
||||
2. Esegui il seguente comando npm:
|
||||
@@ -36,13 +92,13 @@ Uno script eseguito una sola volta che aggiunge automaticamente un determinato n
|
||||
npm run create-empty-steps X # dove X è il numero di step da creare.
|
||||
```
|
||||
|
||||
## insert-step
|
||||
### insert-step
|
||||
|
||||
Uno script una tantum che aggiunge automaticamente un nuovo passo in una posizione specificata, incrementando tutti i passaggi successivi (sia i loro titoli che in meta.json). Il codice seed della sfida userà il codice seed di quella precedente, rimuovendo i marcatori delle regioni editabili (MRE).
|
||||
A one-off script that automatically adds a new step at a specified position, incrementing all subsequent steps (both their titles and in their meta.json). The challenge seed code will use the previous step's challenge seed code with the editable region markers (ERMs) removed.
|
||||
|
||||
**Nota:** Questo script esegue anche [update-step-titles](#update-step-titles).
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### Come eseguire lo script:
|
||||
#### How to run script:
|
||||
|
||||
1. Vai alla directory del progetto.
|
||||
2. Esegui il seguente comando npm:
|
||||
@@ -51,13 +107,13 @@ Uno script una tantum che aggiunge automaticamente un nuovo passo in una posizio
|
||||
npm run insert-step X # dove X è la posizione in cui inserire il nuovo step.
|
||||
```
|
||||
|
||||
## delete-step
|
||||
### delete-step
|
||||
|
||||
Uno script una tantum che rimuove uno step esistente, decrementando tutti i passaggi successivi (sia i loro titoli che in meta.json)
|
||||
A one-off script that deletes an existing step, decrementing all subsequent steps (both their titles and in their meta.json)
|
||||
|
||||
**Nota:** Questo script esegue anche [update-step-titles](#update-step-titles).
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### Come eseguire lo script
|
||||
#### How to run script
|
||||
|
||||
1. Vai alla directory del progetto.
|
||||
2. Esegui il seguente comando npm:
|
||||
@@ -66,11 +122,11 @@ Uno script una tantum che rimuove uno step esistente, decrementando tutti i pass
|
||||
npm run delete-step num=x # dove x è il numero dello step da eliminare.
|
||||
```
|
||||
|
||||
## update-step-titles
|
||||
### update-step-titles
|
||||
|
||||
Uno script una tantum che aggiorna automaticamente il frontmatter nei file di markdown di un progetto in modo che siano coerenti con il progetto meta.json. Fa in modo che il titolo di ogni passo (e DashedName) corrisponda al challengeOrder in meta.
|
||||
A one-off script that automatically updates the frontmatter in a project's markdown files so that they are consistent with the project's meta.json. It ensures that each step's title (and dashedName) match the meta's challengeOrder.
|
||||
|
||||
### Come eseguire lo script
|
||||
#### How to run script
|
||||
|
||||
1. Vai alla directory del progetto.
|
||||
2. Esegui il seguente comando npm:
|
||||
|
||||
@@ -1,18 +1,74 @@
|
||||
# プラクティスプロジェクトに貢献する
|
||||
|
||||
`tools/challenge-helper-scripts` フォルダには、freeCodeCamp プロジェクトベースのカリキュラムの作成とメンテナンスを容易にするためのツールが含まれています。
|
||||
Our practice projects use a step-based approach to teach concepts to campers. A project will consist of multiple files, which we refer to as **"steps"**. These files are named by the challenge ID, to avoid issues with the translation flow. Unfortunately, this makes it difficult to find the file associated with a specific step.
|
||||
|
||||
## 新規プロジェクトを作成する
|
||||
We've built a challenge editor tool that helps remedy this. This tool allows you to navigate the available projects, and the steps for each project (in order). There's also an embedded code editor you can use to work on the files directly.
|
||||
|
||||
`npm run create-project` を実行します。 これにより、プロセスをガイドするコマンドライン UI が開きます。 そうすると、英語のカリキュラムに新しいチャレンジがあるはずですので、プロジェクトの最初のステップに使用できます。 例えば、レスポンシブ Web デザイン認定講座で `test-project` というプロジェクトを作成した場合、`curriculum/challenges/english/01-responsive-web-design/test-project` になります。
|
||||
## Using the Challenge Editor
|
||||
|
||||
新しいステップを作成したい場合は、以下のツールでそのプロセスを簡素化できます。
|
||||
These instructions will tell you how to use our challenge editor tool to work on the practice projects.
|
||||
|
||||
## 次のステップを作成する
|
||||
### 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.
|
||||
|
||||
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.
|
||||
|
||||
### Navigating the Editor
|
||||
|
||||
The default view will list the available `superblocks` - these are the certifications. Click on the certification link you want to work on.
|
||||
|
||||
This will take you to the list of blocks. These are the practice projects. Click on the project link you want to work on.
|
||||
|
||||
This will take you to a list of steps for the project. If you are working on an existing step, you can click on the step link to open the editor. If you are adding or removing steps, click the `Use the step tools` link to switch to the step tools for that challenge.
|
||||
|
||||
### Editing Steps
|
||||
|
||||
When you click on a step, you'll be taken to the editor. This is a basic text editor that offers syntax highlighting.
|
||||
|
||||
After you have made your changes, click the `Save Changes` button to save your changes. You will get a browser alert letting you know that your changes are ready to commit. Note that you'll need to use `git` manually to stage and commit your files - this tool will not do that for you.
|
||||
|
||||
### Step Tools
|
||||
|
||||
When you click the `Use the step tools` link, you'll be taken to the step tools page. This allows you to add or remove steps from the project.
|
||||
|
||||
#### Create Next Step
|
||||
|
||||
Clicking this button will add a new step at the end of the project. This step will use the previous step's code as the seed.
|
||||
|
||||
#### Create Empty Steps
|
||||
|
||||
Enter the number of steps you want to add in the input. Then, clicking the button will create that many empty steps at the end of the project.
|
||||
|
||||
#### Insert Step
|
||||
|
||||
Enter the step number that you want to add a step _after_. For example, if you want to add a step after `step-12`, enter `12`. Then, click the `Insert Step` button to add the step. The following steps will be re-ordered.
|
||||
|
||||
#### Delete Step
|
||||
|
||||
Enter the step number you want to delete. Then click the `Delete Step` button to remove that step. This will automatically update the step numbers for the remaining steps.
|
||||
|
||||
#### Update Step Titles
|
||||
|
||||
You should not have to use this tool unless you've manually deleted or added steps. This tool will reorder the step numbers.
|
||||
|
||||
## Using the Scripts Manually
|
||||
|
||||
If you want to work on the steps manually, in your local IDE, you can run the step management scripts directly.
|
||||
|
||||
The `tools/challenge-helper-scripts` folder contains tools to help facilitate the creation and maintenance of the freeCodeCamp project-based curriculum.
|
||||
|
||||
### 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`.
|
||||
|
||||
If you want to create new steps, the following tools simplify that process.
|
||||
|
||||
### create-next-step
|
||||
|
||||
A one-off script that will automatically add the next step based on the last step in the project. The challenge seed code will use the previous step's challenge seed code.
|
||||
|
||||
### スクリプトを実行する方法
|
||||
#### How to run script:
|
||||
|
||||
1. プロジェクトのディレクトリに変更します。
|
||||
2. 以下の npm コマンドを実行します。
|
||||
@@ -21,13 +77,13 @@ A one-off script that will automatically add the next step based on the last ste
|
||||
npm run create-next-step
|
||||
```
|
||||
|
||||
## 空のステップを作成する
|
||||
### create-empty-steps
|
||||
|
||||
A one-off script that automatically adds a specified number of steps. The challenge seed code for all steps created will be empty.
|
||||
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### スクリプトを実行する方法
|
||||
#### How to run script:
|
||||
|
||||
1. プロジェクトのディレクトリに変更します。
|
||||
2. 以下の npm コマンドを実行します。
|
||||
@@ -36,13 +92,13 @@ A one-off script that automatically adds a specified number of steps. The challe
|
||||
npm run create-empty-steps X # where X is the number of steps to create.
|
||||
```
|
||||
|
||||
## insert-step
|
||||
### insert-step
|
||||
|
||||
A one-off script that automatically adds a new step at a specified position, incrementing all subsequent steps (both their titles and in their meta.json). The challenge seed code will use the previous step's challenge seed code with the editable region markers (ERMs) removed.
|
||||
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### スクリプトを実行する方法
|
||||
#### How to run script:
|
||||
|
||||
1. プロジェクトのディレクトリに変更します。
|
||||
2. 以下の npm コマンドを実行します。
|
||||
@@ -51,13 +107,13 @@ A one-off script that automatically adds a new step at a specified position, inc
|
||||
npm run insert-step X # where X is the position to insert the new step.
|
||||
```
|
||||
|
||||
## ステップを削除する
|
||||
### delete-step
|
||||
|
||||
A one-off script that deletes an existing step, decrementing all subsequent steps (both their titles and in their meta.json)
|
||||
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### スクリプトを実行する方法
|
||||
#### How to run script
|
||||
|
||||
1. プロジェクトのディレクトリに変更します。
|
||||
2. 以下の npm コマンドを実行します。
|
||||
@@ -66,11 +122,11 @@ A one-off script that deletes an existing step, decrementing all subsequent step
|
||||
npm run delete-step X # where X is the step number to be deleted.
|
||||
```
|
||||
|
||||
## update-step-titles
|
||||
### update-step-titles
|
||||
|
||||
A one-off script that automatically updates the frontmatter in a project's markdown files so that they are consistent with the project's meta.json. It ensures that each step's title (and dashedName) match the meta's challengeOrder.
|
||||
|
||||
### How to run script
|
||||
#### How to run script
|
||||
|
||||
1. プロジェクトのディレクトリに変更します。
|
||||
2. 以下の npm コマンドを実行します。
|
||||
|
||||
@@ -1,18 +1,74 @@
|
||||
# Como trabalhar em projetos práticos
|
||||
|
||||
A pasta `tools/challenge-helper-scripts` contém ferramentas para ajudar a facilitar a criação e a manutenção dos projetos baseados no currículo do freeCodeCamp.
|
||||
Our practice projects use a step-based approach to teach concepts to campers. A project will consist of multiple files, which we refer to as **"steps"**. These files are named by the challenge ID, to avoid issues with the translation flow. Unfortunately, this makes it difficult to find the file associated with a specific step.
|
||||
|
||||
## Criando um novo projeto
|
||||
We've built a challenge editor tool that helps remedy this. This tool allows you to navigate the available projects, and the steps for each project (in order). There's also an embedded code editor you can use to work on the files directly.
|
||||
|
||||
Execute `npm run create-project`. 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 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`.
|
||||
## Using the Challenge Editor
|
||||
|
||||
Se você quer criar novos passos, as ferramentas a seguir vão simplificar o processo.
|
||||
These instructions will tell you how to use our challenge editor tool to work on the practice projects.
|
||||
|
||||
## create-next-step (criar próximo passo)
|
||||
### Starting the Editor
|
||||
|
||||
Um script único que adicionará automaticamente a próxima etapa com base na última etapa do projeto. O código seed do desafio usará o código do desafio da etapa anterior.
|
||||
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.
|
||||
|
||||
### Como executar esse script:
|
||||
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.
|
||||
|
||||
### Navigating the Editor
|
||||
|
||||
The default view will list the available `superblocks` - these are the certifications. Click on the certification link you want to work on.
|
||||
|
||||
This will take you to the list of blocks. These are the practice projects. Click on the project link you want to work on.
|
||||
|
||||
This will take you to a list of steps for the project. If you are working on an existing step, you can click on the step link to open the editor. If you are adding or removing steps, click the `Use the step tools` link to switch to the step tools for that challenge.
|
||||
|
||||
### Editing Steps
|
||||
|
||||
When you click on a step, you'll be taken to the editor. This is a basic text editor that offers syntax highlighting.
|
||||
|
||||
After you have made your changes, click the `Save Changes` button to save your changes. You will get a browser alert letting you know that your changes are ready to commit. Note that you'll need to use `git` manually to stage and commit your files - this tool will not do that for you.
|
||||
|
||||
### Step Tools
|
||||
|
||||
When you click the `Use the step tools` link, you'll be taken to the step tools page. This allows you to add or remove steps from the project.
|
||||
|
||||
#### Create Next Step
|
||||
|
||||
Clicking this button will add a new step at the end of the project. This step will use the previous step's code as the seed.
|
||||
|
||||
#### Create Empty Steps
|
||||
|
||||
Enter the number of steps you want to add in the input. Then, clicking the button will create that many empty steps at the end of the project.
|
||||
|
||||
#### Insert Step
|
||||
|
||||
Enter the step number that you want to add a step _after_. For example, if you want to add a step after `step-12`, enter `12`. Then, click the `Insert Step` button to add the step. The following steps will be re-ordered.
|
||||
|
||||
#### Delete Step
|
||||
|
||||
Enter the step number you want to delete. Then click the `Delete Step` button to remove that step. This will automatically update the step numbers for the remaining steps.
|
||||
|
||||
#### Update Step Titles
|
||||
|
||||
You should not have to use this tool unless you've manually deleted or added steps. This tool will reorder the step numbers.
|
||||
|
||||
## Using the Scripts Manually
|
||||
|
||||
If you want to work on the steps manually, in your local IDE, you can run the step management scripts directly.
|
||||
|
||||
The `tools/challenge-helper-scripts` folder contains tools to help facilitate the creation and maintenance of the freeCodeCamp project-based curriculum.
|
||||
|
||||
### 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`.
|
||||
|
||||
If you want to create new steps, the following tools simplify that process.
|
||||
|
||||
### create-next-step
|
||||
|
||||
A one-off script that will automatically add the next step based on the last step in the project. The challenge seed code will use the previous step's challenge seed code.
|
||||
|
||||
#### How to run script:
|
||||
|
||||
1. Mude para o diretório do projeto.
|
||||
2. Execute o comando npm a seguir:
|
||||
@@ -21,13 +77,13 @@ Um script único que adicionará automaticamente a próxima etapa com base na ú
|
||||
npm run create-next-step
|
||||
```
|
||||
|
||||
## create-empty-steps (criar passos vazios)
|
||||
### create-empty-steps
|
||||
|
||||
Um script único que adiciona automaticamente um número específico de etapas. O código seed de todos os passos criados estarão vazios.
|
||||
A one-off script that automatically adds a specified number of steps. The challenge seed code for all steps created will be empty.
|
||||
|
||||
**Observação:** esse script também executa [update-step-titles](#update-step-titles).
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### Como executar esse script:
|
||||
#### How to run script:
|
||||
|
||||
1. Mude para o diretório do projeto.
|
||||
2. Execute o comando npm a seguir:
|
||||
@@ -36,13 +92,13 @@ Um script único que adiciona automaticamente um número específico de etapas.
|
||||
npm run create-empty-steps X #, onde X é o número de etapas a serem criadas.
|
||||
```
|
||||
|
||||
## insert-step
|
||||
### insert-step
|
||||
|
||||
Um script único que adiciona automaticamente uma nova etapa em uma posição especificada, incrementando todas as etapas subsequentes (seus títulos e em seu meta.json). O código inicial de desafio usará o código inicial de desafio da etapa anterior com os marcadores de região editáveis (ERMs) removidos.
|
||||
A one-off script that automatically adds a new step at a specified position, incrementing all subsequent steps (both their titles and in their meta.json). The challenge seed code will use the previous step's challenge seed code with the editable region markers (ERMs) removed.
|
||||
|
||||
**Observação:** esse script também executa [update-step-titles](#update-step-titles).
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### Como executar esse script:
|
||||
#### How to run script:
|
||||
|
||||
1. Mude para o diretório do projeto.
|
||||
2. Execute o comando npm a seguir:
|
||||
@@ -51,13 +107,13 @@ Um script único que adiciona automaticamente uma nova etapa em uma posição es
|
||||
npm run insert-step X #, onde X é a posição para inserir a nova etapa.
|
||||
```
|
||||
|
||||
## delete-step
|
||||
### delete-step
|
||||
|
||||
Um script único que exclui uma etapa existente, decrementa todas as etapas posteriores (seus títulos e em seu meta.json)
|
||||
A one-off script that deletes an existing step, decrementing all subsequent steps (both their titles and in their meta.json)
|
||||
|
||||
**Observação:** esse script também executa [update-step-titles](#update-step-titles).
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### Como executar esse script
|
||||
#### How to run script
|
||||
|
||||
1. Mude para o diretório do projeto.
|
||||
2. Execute o comando npm a seguir:
|
||||
@@ -66,11 +122,11 @@ Um script único que exclui uma etapa existente, decrementa todas as etapas post
|
||||
npm run delete-step X #, onde X é o número do passo a ser excluído.
|
||||
```
|
||||
|
||||
## update-step-titles
|
||||
### update-step-titles
|
||||
|
||||
Um script único que atualiza automaticamente a frontmatter nos arquivos markdown de um projeto para que eles sejam consistentes com o meta.json do projeto. Garante que o título de cada etapa (e dashedName) correspondam ao challengeOrder do arquivo meta.
|
||||
A one-off script that automatically updates the frontmatter in a project's markdown files so that they are consistent with the project's meta.json. It ensures that each step's title (and dashedName) match the meta's challengeOrder.
|
||||
|
||||
### Como executar o script
|
||||
#### How to run script
|
||||
|
||||
1. Mude para o diretório do projeto.
|
||||
2. Execute o comando npm a seguir:
|
||||
|
||||
@@ -1,18 +1,74 @@
|
||||
# How to Work on Practice Projects
|
||||
|
||||
Our practice projects use a step-based approach to teach concepts to campers. A project will consist of multiple files, which we refer to as **"steps"**. These files are named by the challenge ID, to avoid issues with the translation flow. Unfortunately, this makes it difficult to find the file associated with a specific step.
|
||||
|
||||
We've built a challenge editor tool that helps remedy this. This tool allows you to navigate the available projects, and the steps for each project (in order). There's also an embedded code editor you can use to work on the files directly.
|
||||
|
||||
## Using the Challenge Editor
|
||||
|
||||
These instructions will tell you how to use our challenge editor tool to work on the practice projects.
|
||||
|
||||
### 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.
|
||||
|
||||
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.
|
||||
|
||||
### Navigating the Editor
|
||||
|
||||
The default view will list the available `superblocks` - these are the certifications. Click on the certification link you want to work on.
|
||||
|
||||
This will take you to the list of blocks. These are the practice projects. Click on the project link you want to work on.
|
||||
|
||||
This will take you to a list of steps for the project. If you are working on an existing step, you can click on the step link to open the editor. If you are adding or removing steps, click the `Use the step tools` link to switch to the step tools for that challenge.
|
||||
|
||||
### Editing Steps
|
||||
|
||||
When you click on a step, you'll be taken to the editor. This is a basic text editor that offers syntax highlighting.
|
||||
|
||||
After you have made your changes, click the `Save Changes` button to save your changes. You will get a browser alert letting you know that your changes are ready to commit. Note that you'll need to use `git` manually to stage and commit your files - this tool will not do that for you.
|
||||
|
||||
### Step Tools
|
||||
|
||||
When you click the `Use the step tools` link, you'll be taken to the step tools page. This allows you to add or remove steps from the project.
|
||||
|
||||
#### Create Next Step
|
||||
|
||||
Clicking this button will add a new step at the end of the project. This step will use the previous step's code as the seed.
|
||||
|
||||
#### Create Empty Steps
|
||||
|
||||
Enter the number of steps you want to add in the input. Then, clicking the button will create that many empty steps at the end of the project.
|
||||
|
||||
#### Insert Step
|
||||
|
||||
Enter the step number that you want to add a step _after_. For example, if you want to add a step after `step-12`, enter `12`. Then, click the `Insert Step` button to add the step. The following steps will be re-ordered.
|
||||
|
||||
#### Delete Step
|
||||
|
||||
Enter the step number you want to delete. Then click the `Delete Step` button to remove that step. This will automatically update the step numbers for the remaining steps.
|
||||
|
||||
#### Update Step Titles
|
||||
|
||||
You should not have to use this tool unless you've manually deleted or added steps. This tool will reorder the step numbers.
|
||||
|
||||
## Using the Scripts Manually
|
||||
|
||||
If you want to work on the steps manually, in your local IDE, you can run the step management scripts directly.
|
||||
|
||||
The `tools/challenge-helper-scripts` folder contains tools to help facilitate the creation and maintenance of the freeCodeCamp project-based curriculum.
|
||||
|
||||
## Create a new project
|
||||
### Create a new project
|
||||
|
||||
Run `npm run create-project`. 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 `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`.
|
||||
|
||||
If you want to create new steps, the following tools simplify that process.
|
||||
|
||||
## create-next-step
|
||||
### create-next-step
|
||||
|
||||
A one-off script that will automatically add the next step based on the last step in the project. The challenge seed code will use the previous step's challenge seed code.
|
||||
|
||||
### How to run script:
|
||||
#### How to run script:
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
@@ -21,13 +77,13 @@ A one-off script that will automatically add the next step based on the last ste
|
||||
npm run create-next-step
|
||||
```
|
||||
|
||||
## create-empty-steps
|
||||
### create-empty-steps
|
||||
|
||||
A one-off script that automatically adds a specified number of steps. The challenge seed code for all steps created will be empty.
|
||||
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### How to run script:
|
||||
#### How to run script:
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
@@ -36,13 +92,13 @@ A one-off script that automatically adds a specified number of steps. The challe
|
||||
npm run create-empty-steps X # where X is the number of steps to create.
|
||||
```
|
||||
|
||||
## insert-step
|
||||
### insert-step
|
||||
|
||||
A one-off script that automatically adds a new step at a specified position, incrementing all subsequent steps (both their titles and in their meta.json). The challenge seed code will use the previous step's challenge seed code with the editable region markers (ERMs) removed.
|
||||
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### How to run script:
|
||||
#### How to run script:
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
@@ -51,13 +107,13 @@ A one-off script that automatically adds a new step at a specified position, inc
|
||||
npm run insert-step X # where X is the position to insert the new step.
|
||||
```
|
||||
|
||||
## delete-step
|
||||
### delete-step
|
||||
|
||||
A one-off script that deletes an existing step, decrementing all subsequent steps (both their titles and in their meta.json)
|
||||
|
||||
**Note:** This script also runs [update-step-titles](#update-step-titles).
|
||||
|
||||
### How to run script
|
||||
#### How to run script
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
@@ -66,11 +122,11 @@ A one-off script that deletes an existing step, decrementing all subsequent step
|
||||
npm run delete-step X # where X is the step number to be deleted.
|
||||
```
|
||||
|
||||
## update-step-titles
|
||||
### update-step-titles
|
||||
|
||||
A one-off script that automatically updates the frontmatter in a project's markdown files so that they are consistent with the project's meta.json. It ensures that each step's title (and dashedName) match the meta's challengeOrder.
|
||||
|
||||
### How to run script
|
||||
#### How to run script
|
||||
|
||||
1. Change to the directory of the project.
|
||||
2. Run the following npm command:
|
||||
|
||||
Reference in New Issue
Block a user