Skip to content

docs: document create-new-project script for labs, quizzes, and reviews #1220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chinar-amrutkar wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: document create-new-project script for labs, quizzes, and reviews #1220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9bde22f
fix: change branch/name-here to branch-name-here in git push commands
chinar-amrutkar Mar 2, 2026
150fade
docs: document create-new-project script for labs, quizzes, and reviews
chinar-amrutkar Mar 3, 2026
f2e3253
Merge branch 'main' into fix/format-pr-1213-v2
chinar-amrutkar Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/content/docs/how-to-work-on-coding-challenges.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -745,6 +745,10 @@ If you are working with the step-based challenges, refer to the [Work on Worksho

There are a few helper scripts that can be used to manage the challenges in a block. Note that these commands should all be run in the block directory. For example:

### Create a New Project

Run `pnpm run create-new-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/blocks/test-project`.
Copy link
Contributor

@majestic-owl448 majestic-owl448 Mar 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Run `pnpm run create-new-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/blocks/test-project`.
Run `pnpm run create-new-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 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/blocks/test-project`.

Copy link
Contributor

@jdwilkin4 jdwilkin4 Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove this since I have a PR open for updating the coding challenges page.

So I can add this section to my PR and this PR can just focus on updating the labs, quizzes, and review pages.


```bash
cd curriculum/challenges/english/blocks/basic-algorithm-scripting
```
Expand Down
12 changes: 11 additions & 1 deletion src/content/docs/how-to-work-on-labs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,14 @@ For the labs that do not have a demo project, the solution can be the minimum ne

The labs that have a demo project have a `demoType` property in the frontmatter with a value of `onClick`, the labs that do not have a demo project do not have a `demoType` project.

The metadata for labs require a `blockLabel` property with a value of `lab`, and a `blockLayout` with a value of `link`.
The metadata for labs require a `blockType` property with a value of `lab`, and a `blockLayout` with a value of `link`.

## Using the Scripts Manually

If you want to work on the challenges 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 `pnpm run create-new-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/blocks/test-project`.
10 changes: 10 additions & 0 deletions src/content/docs/how-to-work-on-quizzes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,3 +169,13 @@ Also, any question that was taken from external quiz sites is prohibited.
Please come up with your own quiz questions and answers.

</Aside>

## Using the Scripts Manually

If you want to work on the challenges 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 `pnpm run create-new-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/blocks/test-project`.
10 changes: 10 additions & 0 deletions src/content/docs/how-to-work-on-reviews.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,13 @@ The metadata for reviews require a `blockLabel` property with a value of `review
Reviews use a `challengeType` of 31.

Reviews have a dashedName with `review-topic`, and titles of the reviews are like `Topic Review`.

## Using the Scripts Manually

If you want to work on the challenges 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 `pnpm run create-new-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/blocks/test-project`.
Loading