Skip to content

docs: include instructions for setting up editor #1150

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

Merged
ojeytonwilliams merged 1 commit into from
Jan 26, 2026
Merged

docs: include instructions for setting up editor #1150

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion src/content/docs/how-to-work-on-workshops.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,13 @@ The metadata for workshops require a `blockType` property with a value of `works

These instructions will tell you how to use our challenge editor tool to work on the workshops.

### Setting Up the Challenge Editor

The first time you want to use the editor, make sure you are in the root freeCodeCamp directory and run: `pnpm challenge-editor-setup`.

### Starting 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.
Once the editor is set up, run `pnpm run challenge-editor` (again in the root directory) 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.

Expand Down