Skip to content

docs(README): clarify installation instructions, resolve #107 #131

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

Merged
merged 1 commit into from
Dec 12, 2024
Merged

docs(README): clarify installation instructions, resolve #107 #131

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
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,26 @@

## Development

### Quick start

```
$ yarn start
$ yarn install // installs all dependencies
$ yarn start // starts local server
```

or
When started successfully, you may access the local server at http://localhost:8000/

### Troubleshooting

Some issues can be resolved by clearing the cache and rebuilding files. The first command is less destructive, while the second resets your local environment from scratch.

```
$ yarn clear // clears local cache, builds (excludes node_modules)
```

or

```
$ yarn clean // clears local cache, builds, node_modules, yarn trash
```

Expand Down
Loading