Skip to content

Commit cf95ddb

Browse files
chore(doc): improve getting started (#747)
* chore(doc): update pnpm completion install * chore: bump required version of pnpm * Update README.md Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com> * fix: lint --------- Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>
1 parent 7634b64 commit cf95ddb

File tree

2 files changed

+37
-5
lines changed

2 files changed

+37
-5
lines changed

.tool-versions

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
nodejs 22.9.0
2-
pnpm 9.12.1
2+
pnpm 9.12.3

README.md

+36-4
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,51 @@ This is the frontend marble monorepo. We use `pnpm` to handle dependancies.
66

77
This README is a global README for the monorepo. Each package may have its own README. You can find them in the `packages/*/README.md` files.
88

9+
> **Disclaimer**
10+
>
11+
> This repository’s README file is intended for internal use by our development team. The documentation provided here is specifically designed for setting up and running the project on macOS.
12+
>
13+
> While external contributions and interest are appreciated, please note that we do not officially support setups on other operating systems. If you encounter issues outside of the macOS environment, support may be limited.
14+
>
15+
> For general documentation and user-facing guides, please refer to our main repository: [Marble Documentation](https://github.com/checkmarble/marble/blob/main/README.md).
16+
917
### Installations
1018

1119
#### Install pnpm
1220

21+
[Install mise-en-place](https://mise.jdx.dev/getting-started.html) or alternatively install pnpm independently
22+
1323
```bash
1424
brew install pnpm
1525
```
1626

1727
> NB: more installation options [here](https://pnpm.io/installation)
1828
19-
To enable shell autocompletion (works for bash, zsh and fish), run:
29+
To enable shell autocompletion, run:
30+
(Bash)
2031

2132
```bash
22-
pnpm install-completion
33+
pnpm completion bash > ~/completion-for-pnpm.bash
34+
echo 'source ~/completion-for-pnpm.bash' >> ~/.bashrc
35+
2336
```
2437

25-
#### Install dependancies
38+
(zsh)
39+
40+
```bash
41+
pnpm completion zsh > ~/completion-for-pnpm.zsh
42+
echo 'source ~/completion-for-pnpm.zsh' >> ~/.zshrc
43+
```
44+
45+
(Fish)
46+
47+
```bash
48+
pnpm completion fish > ~/.config/fish/completions/pnpm.fish
49+
```
50+
51+
More info at https://pnpm.io/completion
52+
53+
#### Install dependencies
2654

2755
```bash
2856
pnpm install
@@ -36,7 +64,11 @@ All required configuration settings are already included inside the `.vscode/set
3664

3765
### Launch
3866

39-
Each packages are located in the `packages` folder. To work in a package, you can use the `--filter` option of `pnpm` to trigger the dedicated scripts present in each `packages/*/package.json`. Exemple to start the app builder in dev mode:
67+
All packages are located in the `packages` folder. To work in a package, you can use the `--filter` option of `pnpm` to trigger the dedicated scripts present in each `packages/*/package.json`. Example to start the app builder in dev mode:
68+
69+
> **Before first launch.**
70+
>
71+
> Follow the [app-builder package README](packages/app-builder/README.md) to setup its env file.
4072
4173
```bash
4274
# This will run the dev script in the ./packages/app-builder/package.json

0 commit comments

Comments
 (0)