Skip to content

Commit bd5d7a9

Browse files
Init
1 parent 6859f7d commit bd5d7a9

File tree

2 files changed

+33
-10
lines changed

2 files changed

+33
-10
lines changed

.github/CONTRIBUTING.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,39 @@ After forking this repository, you'll want to [create a branch](https://docs.git
5353

5454
#### 3. Install dependencies and run the project locally
5555

56-
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.
57-
58-
You can easily do this by running the command `nvm use`.
59-
60-
To start your local version of GitBook, run the command `bun dev`.
56+
##### Prerequisites:
57+
- Node.js (Version: >=20.6)
58+
- Use `nvm` for easy Node management
59+
- [Bun](https://bun.sh/) (Version: >=1.2.15)
60+
- We use a text-based lockfile which isn't supported below 1.2.15
61+
62+
##### Setup steps:
63+
64+
1. Ensure you are using the project's version of Node:
65+
```bash
66+
nvm use
67+
```
68+
69+
2. Install dependencies using Bun:
70+
```bash
71+
bun install
72+
```
73+
74+
3. Build the project:
75+
```bash
76+
bun build:v2
77+
```
78+
79+
4. Start the development server:
80+
```bash
81+
bun dev:v2
82+
```
83+
84+
Additional development commands:
85+
- `bun format`: Format the code using Biome
86+
- `bun typecheck`: Run TypeScript type checking
87+
- `bun unit`: Run unit tests
88+
- `bun e2e`: Run end-to-end tests
6189

6290
#### 4. Preview your changes
6391

README.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,6 @@ examples:
7777

7878
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.
7979

80-
### Other development commands
81-
82-
- `bun format`: format the code
83-
- `bun lint`: lint the code
84-
8580
### CI and testing
8681

8782
All pull-requests will be tested against both visual and performances testing to prevent regressions.

0 commit comments

Comments
 (0)