diff options
-rw-r--r-- | demo-project-specs.md | 43 | ||||
-rw-r--r-- | readme.md | 2 |
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 | --- | ||
2 | title: > | ||
3 | UGE / L2 / Intro to relational databases / Python project prototype / | ||
4 | Money transfer platform specification | ||
5 | |||
6 | author: Pacien TRAN-GIRARD | ||
7 | date: 2021-07-24 | ||
8 | ... | ||
9 | |||
10 | |||
11 | # Project description | ||
12 | |||
13 | The goal is to create a platform on which users can send money to each others. | ||
14 | |||
15 | |||
16 | ## Accounts | ||
17 | |||
18 | Unauthenticated visitors can to either create a new account or log in into an | ||
19 | existing one using their username and the matching password. | ||
20 | |||
21 | ### Balance | ||
22 | |||
23 | Each account has a balance, which must remain non-negative at all times. | ||
24 | |||
25 | ### Transaction log | ||
26 | |||
27 | Users can see a log of all of the financial transactions which involved them. | ||
28 | |||
29 | |||
30 | ## Operations | ||
31 | |||
32 | ### Deposit and withdrawal | ||
33 | |||
34 | Users can deposit and withdraw an arbitrary amount of money to and from their | ||
35 | account. Both operations are free. | ||
36 | |||
37 | ### Money transfer | ||
38 | |||
39 | Users can send money between each others, referred to by their respective | ||
40 | usernames. | ||
41 | |||
42 | Each transaction between users has a fee of 10% of the transferred amount. | ||
43 | |||
@@ -12,7 +12,7 @@ assignment as both students and the teaching staff are already familiar with | |||
12 | the former from preceding units. | 12 | the former from preceding units. |
13 | 13 | ||
14 | To showcase Python as a platform suitable for this purpose, a small demo | 14 | To showcase Python as a platform suitable for this purpose, a small demo |
15 | project specified will be implemented. | 15 | project specified in `./demo-project-specs.md` will be implemented. |
16 | 16 | ||
17 | 17 | ||
18 | ## Copyright and licensing | 18 | ## Copyright and licensing |