6.3 KiB
Cómo Trabajar en Proyectos de Práctica
Nuestros proyectos de práctica utilizan un enfoque basado en pasos para enseñar conceptos a los campistas. Un proyecto constará de múltiples archivos, a los que nos referimos como "pasos". Estos archivos son nombrados por el ID de desafío, para evitar problemas con el flujo de traducción. Desafortunadamente, esto hace difícil encontrar el archivo asociado a un paso específico.
Hemos creado una herramienta de edición de desafíos que ayuda a remediar eso. Esta herramienta permite navegar los proyectos disponibles y los pasos para cada proyecto (en orden). También hay un editor de código embebido que se puede utilizar para trabajar directamente sobre los archivos.
Utilizando el editor de desafíos
Estas instrucciones le indicarán cómo utilizar nuestra herramienta de edición de desafíos para trabajar en los proyectos de práctica.
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.
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.
Navegando por el Editor
La vista predeterminada mostrará una lista de los superbloques disponibles: estas son las certificaciones. 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. 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:
- Redirígete al directorio del proyecto.
- Ejecuta el siguiente comando npm:
Ejecuta npm crear siguiente paso
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.
How to run script:
- Redirígete al directorio del proyecto.
- Ejecuta el siguiente comando npm:
npm run create-empty-steps X # donde X es el número de pasos a crear.
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.
How to run script:
- Redirígete al directorio principal del proyecto.
- Ejecuta el siguiente comando npm:
npm run insert-step X # donde X es la posición para insertar el nuevo paso.
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.
How to run script
- Redirígete al directorio principal del proyecto.
- Ejecuta el siguiente comando npm:
npm ejecuta delete-step X # donde X es el número de paso a ser eliminado.
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.
Como ejecutar un script
- Redirígete al directorio del proyecto.
- Ejecuta el siguiente comando npm:
npm run update-step-titles