Skip to content

Commit dd076b2

Browse files
committed
README updated
1 parent 3ccc05e commit dd076b2

File tree

2 files changed

+96
-2
lines changed

2 files changed

+96
-2
lines changed

README.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Online Banking System V2.0
2+
3+
This is a Online Banking Concept created using Django Web Framework.
4+
5+
## Features
6+
7+
* Create Bank Account.
8+
* Deposit & Withdraw Money
9+
* Bank Account Type Support
10+
* Interest calculation depending on the Account type
11+
* Transaction report with a date range filter and balance after every transaction
12+
* Count Monthly Interest Using Celery
13+
* More efficient and accurate interest calculation and balance update
14+
* Ability to add Minimum and Maximum Transaction amount restriction
15+
* Modern UI with Tailwind CSS
16+
17+
18+
## Prerequisites
19+
20+
Be sure you have the following installed on your development machine:
21+
22+
+ Python >= 3.7
23+
+ Redis Server
24+
+ Git
25+
+ pip
26+
+ Virtualenv (virtualenvwrapper is recommended)
27+
28+
## Requirements
29+
30+
+ celery==4.4.7
31+
+ Django==3.1
32+
+ django-celery-beat==2.0.0
33+
+ python-dateutil==2.8.1
34+
+ redis==3.5.3
35+
36+
## Install Redis Server
37+
38+
[Redis Quick Start](https://redis.io/topics/quickstart)
39+
40+
Run Redis server
41+
```bash
42+
redis-server
43+
```
44+
45+
## Project Installation
46+
47+
To setup a local development environment:
48+
49+
Create a virtual environment in which to install Python pip packages. With [virtualenv](https://pypi.python.org/pypi/virtualenv),
50+
```bash
51+
virtualenv venv # create a virtualenv
52+
source venv/bin/activate # activate the Python virtualenv
53+
```
54+
55+
or with [virtualenvwrapper](http://virtualenvwrapper.readthedocs.org/en/latest/),
56+
```bash
57+
mkvirtualenv -p python3 {{project_name}} # create and activate environment
58+
workon {{project_name}} # reactivate existing environment
59+
```
60+
61+
Clone GitHub Project,
62+
```bash
63+
git@github.com:saadmk11/banking-system.git
64+
65+
cd banking-system
66+
```
67+
68+
Install development dependencies,
69+
```bash
70+
pip install -r requirements.txt
71+
```
72+
73+
Migrate Database,
74+
```bash
75+
python manage.py migrate
76+
```
77+
78+
Run the web application locally,
79+
```bash
80+
python manage.py runserver # 127.0.0.1:8000
81+
```
82+
83+
Create Superuser,
84+
```bash
85+
python manage.py createsuperuser
86+
```
87+
88+
Run Celery
89+
(Different Terminal Window with Virtual Environment Activated)
90+
```bash
91+
celery -A banking_system worker -l info
92+
93+
celery -A banking_system beat -l info
94+
```
95+
96+
## Images:

templates/core/index.html

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,5 @@ <h1 class="font-bold text-4xl my-4">Banking System</h1>
2020
<div class="w-full lg:w-1/2 lg:py-6 text-center">
2121
<h1 style="font-size: 12rem" class="font-black text-gray-800">$$$</h1>
2222
</div>
23-
24-
2523
</div>
2624
{% endblock %}

0 commit comments

Comments
 (0)