Skip to content

Commit bc1e2fc

Browse files
Docs Updated
1 parent f4092ec commit bc1e2fc

File tree

2 files changed

+28
-6
lines changed

2 files changed

+28
-6
lines changed

README.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,16 @@ A production-grade flask application that you can start your projects without he
88
- [x] Orator ORM module
99
- [x] Celery for background jobs
1010
- [x] Managed Routing using Blueprints
11-
- [x] Data and Route Caching
11+
- [x] Data and Route Caching using Flask-Cache
1212
- [x] File Storage using Depot
13+
- [x] Authentication using Flask-Login
14+
- [x] Email using Flask-Mail
1315

14-
**Running Application**
16+
**Application Setup**
1517

16-
First of all copy `.env.example` and create new `.env` file. And then,
18+
First of all copy `.env.example` and create new `.env` file. Set required configurations for mails and databases in `.env`.
1719

18-
```python
20+
```sh
1921
# create virtual environment
2022
python -m venv venv
2123

@@ -25,8 +27,26 @@ source venv/bin/activate
2527
# install project dependencies
2628
pip install -r requirements.txt
2729

28-
# start gunicorn server
30+
# migrate database
31+
python db.py migrate
32+
33+
# run database seeder, this will setup default admin credentials for our backend
34+
python db.py db:seed
35+
```
36+
37+
**Running Application**
38+
39+
You can run application using multiple methods:
40+
41+
```python
42+
# using wsgi
43+
python wsgi.py
44+
45+
# gunicorn server
2946
gunicorn -w 4 wsgi:server -t 90 0.0.0.0:5000 --reload
47+
48+
# using sh
49+
./run
3050
```
3151

3252
**ORM**
@@ -35,7 +55,7 @@ This application uses orator orm. You can find details **[here](https://orator-o
3555

3656
```sh
3757
# Creating migration
38-
python db.py make:migration create_users_table
58+
python db.py make:migration create_users_table --create --table=users
3959

4060
# Run migration
4161
python db.py migrate

__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
import app
2+
import config

0 commit comments

Comments
 (0)