aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpacien2021-07-24 11:12:53 +0200
committerpacien2021-07-24 11:12:53 +0200
commit431fca39b8ea7ed55d2e6aafede28145009a8727 (patch)
tree2b04b98c70786d080e62e271cd5ad64561cd7c3f
parent22184b7d6ecfdd8161fd7f73c74b38d1219d2e02 (diff)
downloaduge_l2_rdbms_python_proto-431fca39b8ea7ed55d2e6aafede28145009a8727.tar.gz
specs: add demo project specifications
-rw-r--r--demo-project-specs.md43
-rw-r--r--readme.md2
2 files changed, 44 insertions, 1 deletions
diff --git a/demo-project-specs.md b/demo-project-specs.md
new file mode 100644
index 0000000..e3bfbeb
--- /dev/null
+++ b/demo-project-specs.md
@@ -0,0 +1,43 @@
1---
2title: >
3 UGE / L2 / Intro to relational databases / Python project prototype /
4 Money transfer platform specification
5
6author: Pacien TRAN-GIRARD
7date: 2021-07-24
8...
9
10
11# Project description
12
13The goal is to create a platform on which users can send money to each others.
14
15
16## Accounts
17
18Unauthenticated visitors can to either create a new account or log in into an
19existing one using their username and the matching password.
20
21### Balance
22
23Each account has a balance, which must remain non-negative at all times.
24
25### Transaction log
26
27Users can see a log of all of the financial transactions which involved them.
28
29
30## Operations
31
32### Deposit and withdrawal
33
34Users can deposit and withdraw an arbitrary amount of money to and from their
35account. Both operations are free.
36
37### Money transfer
38
39Users can send money between each others, referred to by their respective
40usernames.
41
42Each transaction between users has a fee of 10% of the transferred amount.
43
diff --git a/readme.md b/readme.md
index 5839c20..b75e14a 100644
--- a/readme.md
+++ b/readme.md
@@ -12,7 +12,7 @@ assignment as both students and the teaching staff are already familiar with
12the former from preceding units. 12the former from preceding units.
13 13
14To showcase Python as a platform suitable for this purpose, a small demo 14To showcase Python as a platform suitable for this purpose, a small demo
15project specified will be implemented. 15project specified in `./demo-project-specs.md` will be implemented.
16 16
17 17
18## Copyright and licensing 18## Copyright and licensing