https://github.com/jihongkim98/drf-api-practice
Exercises on building a REST API using Django Rest Framework and other technologies.
https://github.com/jihongkim98/drf-api-practice
celery celery-beat crud-api decouple django django-rest-framework djangorestframework-simplejwt docker drf-spectacular rabbitmq simple-jwt swagger
Last synced: 3 months ago
JSON representation
Exercises on building a REST API using Django Rest Framework and other technologies.
- Host: GitHub
- URL: https://github.com/jihongkim98/drf-api-practice
- Owner: JiHongKim98
- Created: 2023-12-06T16:14:19.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-01T16:04:38.000Z (over 2 years ago)
- Last Synced: 2025-08-12T16:36:37.917Z (12 months ago)
- Topics: celery, celery-beat, crud-api, decouple, django, django-rest-framework, djangorestframework-simplejwt, docker, drf-spectacular, rabbitmq, simple-jwt, swagger
- Language: Python
- Homepage:
- Size: 98.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DRF API Practice
Exercises on building a REST API using Django Rest Framework and other technologies.
## Technologies Used
- Django REST Framework
- Simple-JWT
- Celery & Celery Beat
- RabbitMQ
- DRF-Spectacular
## Basic Features
- API Documentation using [DRF-Spectacular](https://github.com/tfranzel/drf-spectacular)
- Email verification on user registration
- Scheduled tasks at regular intervals
- Custom JWT authentication for HttpOnly attribute
- CRUD operations for Posts, Comments, and Users
- Dockerization for local development
## ER-Diagram
> Implemented a simple structure using SQLite3 to practice integrating API CRUD operations and other technologies.
Entity-Relationship Diagram generated using [dbdiagram.io](https://dbdiagram.io/)
## Getting Started
Clone this repository to your local machine, rename the `.env.example` file to `.env`, and update the environment variables accordingly.
Then, run the following command:
```bash
$ docker-compose up
```
And you can navigate to [`http://localhost:8000/docs/swagger/`](http://localhost:8000/docs/swagger/) or [`http://localhost:8000/docs/redoc/`](http://localhost:8000/docs/redoc/) to view the the API documentation.
If you want start test or create super user:
```bash
# start test
$ docker-compose exec web python3 manage.py test
# create super user
$ docker-compose exec web python3 manage.py createsuperuser
```
If you encounter the `exec /code/entrypoint.sh: no such file or directory` error while running `docker-compose up` on Windows.
Execute the following command to disable automatic conversion from LF to CRLF:
```bash
$ git config --global core.autocrlf false
```
After running this command, clone the repository again to ensure proper configuration.