aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoris2021-01-03 13:40:40 +0100
committerJoris2021-01-03 13:54:20 +0100
commit11052951b74b9ad4b6a9412ae490086235f9154b (patch)
tree64526ac926c1bf470ea113f6cac8a33158684e8d /README.md
parent371449b0e312a03162b78797b83dee9d81706669 (diff)
downloadbudget-11052951b74b9ad4b6a9412ae490086235f9154b.tar.gz
budget-11052951b74b9ad4b6a9412ae490086235f9154b.tar.bz2
budget-11052951b74b9ad4b6a9412ae490086235f9154b.zip
Rewrite in Rust
Diffstat (limited to 'README.md')
-rw-r--r--README.md68
1 files changed, 25 insertions, 43 deletions
diff --git a/README.md b/README.md
index 8c736d4..b5c09a2 100644
--- a/README.md
+++ b/README.md
@@ -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`.