Skip to content

Commit

Permalink
Merge pull request #20 from svsticky/docs/19-lack-of-readme
Browse files Browse the repository at this point in the history
added README
  • Loading branch information
SamStaijen authored Dec 2, 2024
2 parents 4086fb8 + 59905a8 commit 41bc5fc
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Digidecs
Digidecs is the online form for committee- and board members to submit their receipts.

# Prerequesites
- [Yarn](https://classic.yarnpkg.com/en/)
- [Rust](https://www.rust-lang.org/)
- [Node](https://nodejs.org/en), >=21.0 (with the strong advice of using nvm :).


# Local Installation
## start the server
1. move to the `server` folder
2. run `cargo build`.
3. run `cargo run -- --config config.json --dry-run`. if on production, remove the `--dry-run` part.

## start the front-end
1. Move to the `frontend` folder.
2. There, run `yarn install`
3. After this, run `yarn run dev`
You now have a hot-reloadable dev enviroment. Happy hacking!

0 comments on commit 41bc5fc

Please sign in to comment.