-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[CSYS-397] create readme for confetti ds (#64)
* 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
1 parent
48a0f15
commit e8d4bbf
Showing
3 changed files
with
31 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters