Skip to content

Improve Readme section for local dev setup #352

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

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

Improve Readme section for local dev setup #352

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
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,20 @@ Please follow our [Specification documentation](https://www.caniusevia.com/docs/

## Local development setup

Start by cloning [`the-via/keyboards`](github.com/the-via/keyboards) then install dependencies with `npm install` and finally `npm run build`. You should see
the output folder `dist`. This should be copied or symlinked to our repo's `public/definitions` folder.

```bash
# Inside the-via/app
public/definitions -> ../../keyboards/dist
```

### Useful commands

#### `npm run start`
#### `npm run dev`

Runs the app in the development mode.
Open [http://localhost:8080](http://localhost:8080) to view it in the browser.
Open [http://localhost:5173](http://localhost:5173) to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.
Expand Down