Skip to content

Commit

Permalink
Development doc
Browse files Browse the repository at this point in the history
  • Loading branch information
undera committed Aug 7, 2023
1 parent e3dc484 commit 6b446df
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions Contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# How to Contribute

## Finding What to Contribute

[Roadmap](Roadmap.md) document contains some notes and ideas on what can be done to improve the project.

## Setting Up For Local Development

You will need Golang 1.20+ and NodeJS 18+.

First you need to build frontend (the API backend won't compile without that). To do so, run `npm run build` inside `pkg/frontend` directory.

To build API backend, run `go build -o bin/komoplane .` in the project root.

For frontend development, start API backend with command `bin/komoplane`, then run `npm run dev` inside `pkg/frontend`. Open the suggested URL in your browser.

0 comments on commit 6b446df

Please sign in to comment.