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

Commit e760bd5

Browse files
committed
chore(docs): updated dev build docs
1 parent 238ad37 commit e760bd5

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

Diff for: README.md

+8
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ You can also view all developed components in Storybook!
1212

1313
<a href="https://kiwi-ui.netlify.com" target="_blank" style="background: #2a4106; color: #9fdc3c; padding: 0.7em; border-radius: 4px; font-weight: 700; box-shadow: 2px 2px 5px rgba(0, 0, 0, 0.1);">🔖 View Storybook</a>
1414

15+
## Development
16+
This current verison of Kiwi uses a forked version of `vue-styled-components`. This will be replaced in the near future. I order to get started with the development environment, run the following commands to install all packages and then build `vue-styled-components` dist. And voila! You're good to go. You only need to run this once after running `yarn install` on this repository.
17+
18+
```bash
19+
yarn install
20+
yarn build-vsc
21+
yarn serve
22+
```
1523

1624
#### Project TODO:
1725
- [x] Setup Storybook for components UI

Diff for: package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
"storybook": "start-storybook -p 6006",
1212
"build-storybook": "build-storybook --quiet",
1313
"docs:dev": "vuepress dev docs",
14-
"docs:build": "vuepress build docs"
14+
"docs:build": "vuepress build docs",
15+
"build-vsc": "cd node_modules/vue-styled-components && npm install && npm run build && cd ../../"
1516
},
1617
"dependencies": {
1718
"@babel/preset-env": "^7.6.3",

0 commit comments

Comments
 (0)