Skip to content
This repository was archived by the owner on Sep 20, 2024. It is now read-only.

Commit 147e85b

Browse files
docs(contributing): update details
1 parent 1123461 commit 147e85b

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,28 @@ git clone https://github.com/<your_github_username>/chakra-ui-vue-next.git
1818
cd chakra-ui
1919
```
2020

21-
3. Build components
22-
```bash
23-
yarn build
21+
3. Install dependencies and bootstrap the project
22+
```sh
23+
yarn
24+
# After the dependencies are installed, the `postinstall` script with trigger `preconstruct dev` which will build all the component packages.
2425
```
2526

26-
4. Setup all the dependencies and packages by running `yarn bootstrap`. This
27-
command will install dependencies and bootstrap the repo using `lerna`
28-
```bash
29-
yarn bootstrap
27+
4. Run the Vite Playground.
3028
```
29+
yarn playground:dev
30+
```
31+
This will boot the playground server and watches for changes in any package.
3132

32-
> If you run into any issues during this step, kindly reach out to the Chakra UI
33+
> If you run into any issues during these steps, kindly reach out to the Chakra UI
3334
> Vue team here:[https://discord.gg/cMpMfvxa](https://discord.gg/cMpMfvxa)
3435
36+
## For Windows OS Users
37+
There may be some trouble specific to the local setup in Windows. The following are suggestions in ensuring the local environment boots up successfully:
38+
39+
- The package dependencies and scripts should work with Node `v16.16.0 and higher`
40+
- If you receive the error `EPERM: operation not permitted, symlink` and mentions `preconstruct`, you will need to enable OS developer mode. See Github issue [#381 for Preconstruct](https://github.com/preconstruct/preconstruct/issues/381)
41+
- If you receive the error `NODE_ENV is not recognized as an internal or external command`, try the package [win-node-env](https://www.npmjs.com/package/win-node-env)
42+
3543
## Development
3644

3745
To improve our development process, we've set up tooling and systems. Chakra UI
@@ -57,7 +65,7 @@ cross-component development and builds all components.
5765
**`yarn bootstrap`**: bootstraps the entire project and symlinks all
5866
dependencies for cross-component development.
5967

60-
**`yarn dev`**: starts components playground server and loads stories in SFCs in the `packages/**/examples/*.vue` file.
68+
**`yarn playground:dev`**: starts components playground server and loads stories in SFCs in the `packages/**/examples/*.vue` file.
6169

6270
**`yarn docs:dev`**: run the documentation site locally.
6371

0 commit comments

Comments
 (0)