Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amirpsd/drf_blog_api
a simple blog and otp Authentication with django rest framework
https://github.com/amirpsd/drf_blog_api
api django django-rest-framework docker docker-compose gunicorn nginx postgresql python
Last synced: 3 days ago
JSON representation
a simple blog and otp Authentication with django rest framework
- Host: GitHub
- URL: https://github.com/amirpsd/drf_blog_api
- Owner: amirpsd
- License: mit
- Created: 2021-10-06T07:43:24.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-05T20:43:45.000Z (5 months ago)
- Last Synced: 2024-06-05T22:34:01.618Z (5 months ago)
- Topics: api, django, django-rest-framework, docker, docker-compose, gunicorn, nginx, postgresql, python
- Language: Python
- Homepage:
- Size: 214 KB
- Stars: 69
- Watchers: 2
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DRF Blog Api With Otp Authentication
This project is a Blog site written with **python3.9** and **Django3.2** and **Django_rest_framework_3.12** which is for using api.
The purpose of this project was to see how a blog with **otp** authentication can be implemented using the django-rest-framework.
## Features
- Authentication with phone number and **Otp** code.
- Send otp code to user's phone.
- Two-step verification for authentication.
- Use cache to temporarily store otp code.
- The presence of throttling in authentication.
- Generate tokens using **simple-jwt** after authentication.
- Production-ready configuration for Static Files, Database Settings, Gunicorn, Ngnix, Docker.
- Easy installation.
- Ability to comment on blogs.
- Ability advanced filter of articles.
- Use the PostgreSQL database to store data.
- Existence of logger for debugging.
- Automated execution of unit tests with GitHub Actions.
## Technologies used
- [Python 3.9](https://www.python.org/) , Programming Language. [](https://img.shields.io/badge/python-3.9-red)
- [Django 3.2](https://docs.djangoproject.com/en/3.2/releases/3.2/) , Web Framework.
- [Django Rest Framework 3.12](https://www.django-rest-framework.org/) , Web API's.
- [JWT](https://jwt.io/), JSON Web Tokens.
- [Nginx](https://www.nginx.com/) , Web Server.
- [Docker](https://www.docker.com/) , Container Platform.
- [PostgreSQL](https://www.postgresql.org/) , Database.
- [Gunicorn](https://gunicorn.org/) , WSGI HTTP Server.
- [Git](https://git-scm.com/doc) , VCS(Version Control System).
- [GitHub Actions](https://docs.github.com/en/actions) , CI/CD.
## Requirements
**install Docker**
To run this project, you must install Docker.
- [install Docker in Linux](https://docs.docker.com/engine/install/)
- [install Docker in Windows](https://docs.docker.com/desktop/windows/install/)
- [install Docker in Mac](https://docs.docker.com/desktop/mac/install/)
and also install docker-compose.
- [install docker-compose](https://docs.docker.com/compose/install/)
## Installation
**Clone the project**
```shell
git clone https://github.com/amirpsd/drf_blog_api.git && cd drf_blog_api
```
Please enter the required information in the **.env** and **.env.db** files before running the project.
**Run project**
**create docker network**
```shell
docker network create nginx_network
docker network create blog_network
```
**create docker volume**
```shell
docker volume create db_data
```
**run project**
```shell
docker-compose up -d
```
You currently have 3 containers running:
- web
- nginx
- db
Now create a super user with a **web** container to access the Django admin panel.
```shell
docker exec -it web python3 manage.py createsuperuser
```
After creating a super user, go to http://127.0.0.1:80/account/api/login/.
And after authentication, create the super user two-step password. http://127.0.0.1:80/account/api/create-two-step-password/
Finally, go to the admin panel. http://127.0.0.1:80/admin/
## Endpoints
You can see the [endpoints.yaml](https://github.com/amirpsd/drf_blog_api/blob/main/endpoints.yaml) file to see the exact details of the endpoints.
or you can go to http://127.0.0.1:80/api/schema/swagger-ui/ or http://127.0.0.1:80/api/schema/redoc/
to see the endpoints after running the project.
## LICENSE
see the [LICENSE](https://github.com/amirpsd/drf_blog_api/blob/main/LICENSE) file for details.