Skip to content

Commit

Permalink
Added step-by-step instructions to the readme (#802)
Browse files Browse the repository at this point in the history
  • Loading branch information
izzyldn authored Jan 27, 2025
1 parent 4556f05 commit 01a5b4a
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
[ ![npm](https://img.shields.io/npm/v/%40ldn-viz%2Ftables?label=%40ldn-viz%2Ftables%20version) ](https://www.npmjs.com/package/@ldn-viz/tables)
[ ![npm](https://img.shields.io/npm/v/%40ldn-viz%2Fthemes?label=%40ldn-viz%2Fthemes%20version) ](https://www.npmjs.com/package/@ldn-viz/themes)
[ ![npm](https://img.shields.io/npm/v/%40ldn-viz%2Fui?label=%40ldn-viz%2Fui%20version) ](https://www.npmjs.com/package/@ldn-viz/ui)
[ ![npm](https://img.shields.io/npm/v/%40ldn-viz%2Futils?label=%40ldn-viz%2Futils%20version) ](https://www.npmjs.com/package/@ldn-viz/utils)

[ ![npm](https://img.shields.io/npm/v/%40ldn-viz%2Futils?label=%40ldn-viz%2Futils%20version) ](https://www.npmjs.com/package/@ldn-viz/utils)

This is a mono-repo containing several components:

Expand Down Expand Up @@ -49,6 +48,17 @@ Storybook needs to be restarted when adding a new story to allow it to index the

You can preview the storybook by running `npm run storybook -w apps/docs`.

#### Step-by-step Set Up

- Clone repository onto local machine
- Switch to dev branch
- Install dependencies: `npm i`
- Create new local branch: `git checkout -B name-of-task`
- Run build script to build the components: `npm run build`
- Run docs script to set up local preview of storybook: `npm run docs`
- Ready to start contributing.
- Once changes have been made, update the change set log: `npx changeset` and push to git.

## Contributing, and Publishing packages

Development should occur in feature branches that are branched off from the `dev` branch.
Expand Down

0 comments on commit 01a5b4a

Please sign in to comment.