diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b93b51896..118fb4df5 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -53,11 +53,39 @@ After forking this repository, you'll want to [create a branch](https://docs.git #### 3. Install dependencies and run the project locally -GitBook uses [Bun](https://bun.sh/) to run the project. Make sure you're using the specified version of `node` before running any of the development commands to ensure a smooth development experience. +##### Prerequisites: +- Node.js (Version: >=20.6) + - Use `nvm` for easy Node management +- [Bun](https://bun.sh/) (Version: >=1.2.15) + - We use a text-based lockfile which isn't supported below 1.2.15 -You can easily do this by running the command `nvm use`. +##### Setup steps: -To start your local version of GitBook, run the command `bun dev`. +1. Ensure you are using the project's version of Node: +```bash +nvm use +``` + +2. Install dependencies using Bun: +```bash +bun install +``` + +3. Build the project: +```bash +bun build:v2 +``` + +4. Start the development server: +```bash +bun dev:v2 +``` + +Additional development commands: +- `bun format`: Format the code using Biome +- `bun typecheck`: Run TypeScript type checking +- `bun unit`: Run unit tests +- `bun e2e`: Run end-to-end tests #### 4. Preview your changes diff --git a/README.md b/README.md index 9b13767ff..e86a06baa 100644 --- a/README.md +++ b/README.md @@ -77,11 +77,6 @@ examples: Any published GitBook site can be accessed through your local development instance, and any updates you make to the codebase will be reflected in your browser. -### Other development commands - -- `bun format`: format the code -- `bun lint`: lint the code - ### CI and testing All pull-requests will be tested against both visual and performances testing to prevent regressions.