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
{{ message }}
This repository was archived by the owner on Sep 20, 2024. It is now read-only.
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
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.
30
25
```
31
26
32
-
> If you run into any issues during this step, kindly reach out to the Chakra UI
27
+
> If you run into any issues during these steps, kindly reach out to the Chakra UI
33
28
> Vue team here:[https://discord.gg/cMpMfvxa](https://discord.gg/cMpMfvxa)
34
29
30
+
## For Windows OS Users
31
+
There may be some trouble specific to the local setup in Windows. The following are suggestions in ensuring the local environment boots up successfully:
32
+
33
+
- The package dependencies and scripts should work with Node `v16.16.0 and higher`
34
+
- 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)
35
+
35
36
## Development
36
37
37
38
To improve our development process, we've set up tooling and systems. Chakra UI
38
39
uses a monorepo structure and we treat each component as an independent package
39
40
that can be consumed in isolation.
40
41
42
+
If you are looking to build a new component, and it has been approved by the team, head over to the [components-guide.md](./docs/guides/component-guide.md) to help you get started!
43
+
41
44
### Tooling
42
45
43
46
-[Lerna](https://lerna.js.org/) to manage installation of dependencies and
@@ -57,7 +60,7 @@ cross-component development and builds all components.
57
60
**`yarn bootstrap`**: bootstraps the entire project and symlinks all
58
61
dependencies for cross-component development.
59
62
60
-
**`yarn dev`**: starts components playground server and loads stories in SFCs in the `packages/**/examples/*.vue` file.
63
+
**`yarn playground:dev`**: starts components playground server and loads stories in SFCs in the `packages/**/examples/*.vue` file.
61
64
62
65
**`yarn docs:dev`**: run the documentation site locally.
63
66
@@ -110,7 +113,9 @@ docs, simply run `yarn build`, and `yarn docs:dev`
110
113
111
114
### Components Development Playground
112
115
113
-
Build components in isolation with Storybook using `yarn dev`
116
+
Build components in isolation with Vite using `yarn playground:dev`
117
+
118
+
Run `yarn start` in a separate terminal first so the packages are built and a watcher set up for changes.
0 commit comments