diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 68 |
1 files changed, 25 insertions, 43 deletions
@@ -1,59 +1,41 @@ -# Shared Cost +# Budget -Share costs with a group of people: +- pay according to your income, +- configure monthly payments, +- get statistics, +- get weekly activity by email. -- Share according to people income, -- Monthly payments available, -- Statistics by month, -- Weekly activity sent by email. +# Technologies -## Getting started +- database: Sqlite +- server: Rust with hyper, sqlx, +- templates: Tera, +- frontend: JavaScript, +- style: CSS. -Install nix: +# Screenshots -``` -curl https://nixos.org/nix/install | sh -``` +## Payments -Start the environment with: +![Payments](docs/payments.png) -```bash -./make start -``` +## Balance -Init the database with migration scripts: +![Balance](docs/balance.png) -```bash -sqlite3 database < server/migrations/1.sql -sqlite3 database < server/migrations/2.sql -sqlite3 database < server/migrations/3.sql -``` +## Statistics -Inside the tmux session, add some users with sqlite after the migration is done: +![Statistics](docs/statistics.png) -``` -sqlite3 database -insert into user(creation, email, name, password) values (datetime('now'), 'john@mail.com', 'John', '$2y$14$1QqyMA8vknmSVBq9BcGi6upZISLwsP2aPXx5JZOMPVzaZ8gorrsq.'); -insert into user(creation, email, name, password) values (datetime('now'), 'lisa@mail.com', 'Lisa', '$2y$14$1QqyMA8vknmSVBq9BcGi6upZISLwsP2aPXx5JZOMPVzaZ8gorrsq.'); -``` +# Getting started -Later, stop the environment with: +1. Use `nix-shell` to download dependencies. -```bash -./make stop -``` +2. Initialize the database with `bin/db init`. -## Deploy +3. Start the application with `bin/watch run`. -```bash -make deploy -``` +4. Connect with either: -## Configuration - -See [application.conf](application.conf). - -## Documentation - -- [reflex](https://hackage.haskell.org/package/reflex-0.6.2.4/docs/doc-index-All.html) -- [reflex-dom](https://hackage.haskell.org/package/reflex-dom-core-0.5/docs/doc-index-All.html) +- `john@mail.com` / `password` +- or `lisa@mail.com` / `password`. |