Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleaned up the client readme file #141

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Cleaned up the client readme file #141

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions client/readme.md → client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

# Client

To start the dev server for the client, first `cd` into the client directory:

```
cd client
```

# Setup

## 1. Install Yarn
Expand All @@ -10,32 +16,38 @@ This [guide](https://classic.yarnpkg.com/en/docs/install/#mac-stable) will descr

## 2. Install Dependencies

```bash
```
yarn install
```

## 3. Start the app
## 3. Set up the env file

```bash
```
mv .env_sample .env
```

## 4. Start the app

```
yarn run dev
```

# Commands

## Test

```bash
```
yarn run test
```

## Format

```bash
```
yarn run format
```

## Storybook

```bash
```
yarn storybook
```