Skip to content

Commit

Permalink
document setup prerequisites (#39)
Browse files Browse the repository at this point in the history
* document setup prerequisites

* make documentation clearer
  • Loading branch information
josefie authored Oct 25, 2022
1 parent 469a088 commit fe49a73
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,28 @@ The system uses [Storybook](https://storybook.js.org/) as a tool for developing

## 🔧 Setup

1. `git clone [email protected]:betterplace/betterplace-design-system.git`
2. `cd betterplace-design-system`
3. `yarn install`
4. `yarn storybook`
### Install prerequisites

## Dependencies
Open a terminal and enter the following `commands` one by one in order to install the tools necessary for running the project:

See [.tool-versions](.tool-versions)
1. Install [Homebrew](https://brew.sh): `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
2. Install [asdf](https://asdf-vm.com/guide/getting-started.html): `brew install asdf`
3. Install global dependencies (see [.tool-versions](.tool-versions)): `asdf install`

### Install the project

To run the project you first need to download all the files to your computer and install some dependencies:

1. Clone the Git repository: `git clone [email protected]:betterplace/betterplace-design-system.git`
2. Change to the directory where all the project files live: `cd betterplace-design-system`
3. Install project's dependencies: `yarn install`

### Run the project

1. If you aren't already there, change to the directory where all the project files live: `cd betterplace-design-system`
2. Start the server and run Storybook in your browser: `yarn storybook`
- This might fail after updating the Git repository. In that case, run `yarn install` again.
3. The browser will open automatically once it's finished. If not, you can open it manually: http://localhost:6006/

## 💻 Development

Expand Down

0 comments on commit fe49a73

Please sign in to comment.