From fe49a7324b4954b20da8965b9c21ee4a76c92ef6 Mon Sep 17 00:00:00 2001 From: josefie Date: Tue, 25 Oct 2022 09:27:24 +0200 Subject: [PATCH] document setup prerequisites (#39) * document setup prerequisites * make documentation clearer --- README.md | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2aea8db9..9bef0796 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,28 @@ The system uses [Storybook](https://storybook.js.org/) as a tool for developing ## 🔧 Setup -1. `git clone git@github.com: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 git@github.com: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