diff --git a/README.md b/README.md new file mode 100644 index 0000000..7b7767c --- /dev/null +++ b/README.md @@ -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 +``` diff --git a/package.json b/package.json index 1957ceb..af488d1 100644 --- a/package.json +++ b/package.json @@ -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" } diff --git a/turbo.json b/turbo.json index 949aa3b..5a2a1ec 100644 --- a/turbo.json +++ b/turbo.json @@ -7,16 +7,11 @@ ], "outputs": ["apps/docs/storybook-static/**"] }, - - "lint": { "outputs": [] }, - "start": { - }, - "test": { - }, - "publish": { - } + "start": {}, + "test": {}, + "publish": {} } -} \ No newline at end of file +}