Skip to content

Commit 6470a70

Browse files
Update setting-up-the-project.md (#9259)
Add `bun.sh` installation as a step for setting up project guide
1 parent 0c2665f commit 6470a70

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

contributing/setting-up-the-project.md

+19-3
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,37 @@ export VOLTA_FEATURE_PNPM=1;
1616

1717
> **Note** if you have previously installed pnpm globally via other means you should uninstall it from all other locations first. You may also need to uninstall nvm or other node version managers if they turn out to conflict.
1818
19-
2. Clone the repository
19+
2. Install bun.sh
20+
21+
If you don't already have [bun.sh](https://bun.sh/)
22+
For MacOS and Linux
23+
```sh
24+
curl -fsSL https://bun.sh/install | bash
25+
```
26+
can be done using homebrew, npm or Docker (User choice) checkout installation [doc](https://bun.sh/docs/installation#macos-and-linux)
27+
28+
For Windows
29+
```sh
30+
# WARNING: No stability is guaranteed on the experimental Windows builds
31+
powershell -c "irm bun.sh/install.ps1|iex"
32+
```
33+
Installation [doc](https://bun.sh/docs/installation#windows)
34+
35+
3. Clone the repository
2036

2137
```sh
2238
git clone git@github.com:emberjs/data.git
2339
```
2440

25-
3. Install the project dependencies
41+
4. Install the project dependencies
2642

2743
```sh
2844
cd data && pnpm install
2945
```
3046

3147
Currently the install command is also what builds all of the individual packages in the monorepo and hardlinks them together, so if making changes to one package that need to be used by another you will need to rerun `pnpm install` for the changes to be picked up.
3248

33-
4. Run some commands
49+
5. Run some commands
3450

3551
Generally test and lint commands can be found in the `"scripts"` section of the root `package.json` manifest. Individual packages or test packages have additional commands in the `"scripts"` section of their own `package.json` manifest as well.
3652

0 commit comments

Comments
 (0)