Skip to content

docs: improve readme "getting started" section #623

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 5 commits into from
Mar 9, 2023
Merged

docs: improve readme "getting started" section #623

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a695c5f
docs: improve readme "getting started" section
kemuru Mar 7, 2023
ba2126e
docs: add compile contracts section
kemuru Mar 8, 2023
76f7a3c
docs: move section to web
kemuru Mar 9, 2023
4902d6c
docs: remove headline
kemuru Mar 9, 2023
9f227ae
docs: fix readme link
kemuru Mar 9, 2023
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: 22 additions & 2 deletions web/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
# @kleros/kleros-v2-web
## Contributing

🚧 ⚖️ 🚧
### Pre-Requisites

If you haven't already, you need to follow all the previous steps of the **Contributing** section of the repo's [README](https://github.com/kleros/kleros-v2/blob/master/README.md#contributing)

### Getting Started

#### Compile the contracts

```bash
# first you need to go to the kleros-v2/contracts folder, and then compile them
$ cd kleros-v2/contracts
$ yarn build
```

#### Start the frontend

```bash
# first you need to be in the kleros-v2/web folder, and then start it
$ cd kleros-v2/web
$ yarn start
```