You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+36-4
Original file line number
Diff line number
Diff line change
@@ -6,23 +6,51 @@ This is the frontend marble monorepo. We use `pnpm` to handle dependancies.
6
6
7
7
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.
8
8
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
+
9
17
### Installations
10
18
11
19
#### Install pnpm
12
20
21
+
[Install mise-en-place](https://mise.jdx.dev/getting-started.html) or alternatively install pnpm independently
22
+
13
23
```bash
14
24
brew install pnpm
15
25
```
16
26
17
27
> NB: more installation options [here](https://pnpm.io/installation)
18
28
19
-
To enable shell autocompletion (works for bash, zsh and fish), run:
pnpm completion fish >~/.config/fish/completions/pnpm.fish
49
+
```
50
+
51
+
More info at https://pnpm.io/completion
52
+
53
+
#### Install dependencies
26
54
27
55
```bash
28
56
pnpm install
@@ -36,7 +64,11 @@ All required configuration settings are already included inside the `.vscode/set
36
64
37
65
### Launch
38
66
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.
40
72
41
73
```bash
42
74
# This will run the dev script in the ./packages/app-builder/package.json
0 commit comments