Skip to content

Commit 681ddaa

Browse files
committed
Update ReadMe.md
1 parent f4f1aa9 commit 681ddaa

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,60 @@
11
# FastAPI and Django Combo
22
This projects aims to combine FastAPI and Django to build a Production ready application capable of utilizing all of the features of both django and FastAPI.
33
To demonstrate, I built a sample blog app, It can be adapted into any app.
4+
5+
![Blog Posts](https://github.com/drmacsika/am-backend/blob/master/templates/Screenshot%202021-10-23%20at%2020.48.16.png)
6+
7+
![Blog Category](https://github.com/drmacsika/am-backend/blob/master/templates/Screenshot%202021-10-23%20at%2020.48.28.png)
8+
9+
![Contact](https://github.com/drmacsika/am-backend/blob/master/templates/Screenshot%202021-10-23%20at%2020.48.39.png)
10+
11+
![User Accounts](https://github.com/drmacsika/am-backend/blob/master/templates/Screenshot%202021-10-23%20at%2020.48.48.png)
12+
13+
![User Auth](https://github.com/drmacsika/am-backend/blob/master/templates/Screenshot%202021-10-23%20at%2020.48.57.png)
14+
15+
## Tools
16+
17+
- Django
18+
- Django Rest Framework (DRF)
19+
- FastAPI
20+
- Pydantic with custom validation
21+
- Django all-auth
22+
- JWT Authentication
23+
- CORS
24+
- Uvicorn and Gunicorn for Python web server
25+
26+
## Features
27+
28+
- CRUD endpoints for blog posts and categories
29+
- CRUD endpoints for contacts
30+
- Asynchronous CRUD endpoints for user accounts
31+
- Endpoints for user authentication using DRF
32+
- Django settings file
33+
- Migrations using Django Migrations
34+
- Django ORM and Admin Page
35+
- JWT token authentication.
36+
37+
## Installation and Usage
38+
39+
Use the package manager [pip](https://pip.pypa.io/en/stable/) for installation.
40+
41+
```bash
42+
- python -m venv venv
43+
- source venv/bin/activate
44+
- pip install -r requirements.txt
45+
- cd fastapi-django-combo
46+
- python manage.py makemigrations
47+
- python manage.py migrate
48+
- uvicorn core.asgi:app --reload
49+
```
50+
51+
## Contributing
52+
53+
Pull requests and contributions are welcome. For major changes, please open an issue first to discuss what you would like to change.
54+
55+
Ensure to follow the [guidelines](https://github.com/drmacsika/fastapi-django-combo/blob/master/CONTRIBUTING.md) and update tests as appropriate.
56+
57+
58+
## Additional Info
59+
60+
For an in-depth understanding of FastAPI or any of the tools used here including questions and collaborations, you can reach out to me.

0 commit comments

Comments
 (0)