-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #20 from svsticky/docs/19-lack-of-readme
added README
- Loading branch information
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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! | ||
|