Skip to content

Commit

Permalink
[CSYS-397] create readme for confetti ds (#64)
Browse files Browse the repository at this point in the history
* docs: creating the confetti-ds README

* fix: updating the start command @ README

* feat: updating the turbo.json

* forcing script build

* fix: restoring files from the cherry-pick

* fix: updating TOML file

* fix: updating the Turborepo config file

* fix: removing duplicated README

Co-authored-by: daniel carvalho <dnc331@gmail.com>
  • Loading branch information
tiidadavena and ddevdan authored Dec 29, 2022
1 parent 48a0f15 commit e8d4bbf
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 11 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Confetti' source code

This project is the Storybook code for our [Confetti design system](https://github.com/labcodes/confetti-ds).

## Setup

First, clone this project. We use git monorepo to manage both the React code and the Storybook source.

```sh
git clone git@github.com:labcodes/confetti-ds.git
```

After that, you'll need to install this project's dependencies, as well as the confetti-ds' own dependencies. We use [Turborepo](turborepo.org/) to manage the both inside projects.

Finally, go back to the root folder and start the development server. That will run a development server that runs at http://localhost:8000 and that contains this whole Storybook site.

```sh
# installs at the project's root folder
npm install
# runs Storybook at localhost:8000
npm run dev
```
7 changes: 5 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@
"devDependencies": {
"turbo": "^1.6.3"
},
"workspaces": ["packages/*", "apps/docs*"],
"workspaces": [
"packages/*",
"apps/docs*"
],
"scripts": {
"dev": "npx turbo start",
"build": "npx turbo build",
"build": "npx turbo build --force",
"test": "npx turbo test",
"publish": "npx turbo publish"
}
Expand Down
13 changes: 4 additions & 9 deletions turbo.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,11 @@
],
"outputs": ["apps/docs/storybook-static/**"]
},


"lint": {
"outputs": []
},
"start": {
},
"test": {
},
"publish": {
}
"start": {},
"test": {},
"publish": {}
}
}
}

0 comments on commit e8d4bbf

Please sign in to comment.