Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/obaraelijah/authors-haven-api
A Django & Django Rest Framework API built with Docker,NGINX,Redis,Portainer and more.... 🔥 🐳
https://github.com/obaraelijah/authors-haven-api
celery django django-rest-framework nginx
Last synced: 7 days ago
JSON representation
A Django & Django Rest Framework API built with Docker,NGINX,Redis,Portainer and more.... 🔥 🐳
- Host: GitHub
- URL: https://github.com/obaraelijah/authors-haven-api
- Owner: obaraelijah
- Created: 2023-06-23T16:58:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-09T14:15:09.000Z (11 months ago)
- Last Synced: 2024-12-03T09:12:04.749Z (2 months ago)
- Topics: celery, django, django-rest-framework, nginx
- Language: Python
- Homepage:
- Size: 181 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Authors: authors_api/__init__.py
Awesome Lists containing this project
README
# Authors Haven API with Docker, NGINX, and Redis
👋 Welcome to the Authors Haven API project! This project showcases a powerful Django & Django Rest Framework API, containerized with Docker, and optimized with NGINX and Redis for improved performance.
## Features
- User authentication and registration
- Create, read, update, and delete articles
- Commenting system for articles
- User profiles with personalized information
- Token-based authentication for secure API access
- Efficient caching using Redis for improved performance
-
## Technologies Used
- Django
- Django Rest Framework
- Docker
- NGINX
- Celery
- Redis
## Getting Started
To run this project locally, you need to have Docker installed. Follow these steps:
### Prerequisites
- Docker: [Installation Guide](https://docs.docker.com/get-docker/)
### Installation
1. Clone this repository:
```bash
https://github.com/obaraelijah/authors-haven-api.git
```
2. Navigate to the project directory:
```bash
cd authors-haven-api
```
3. Build and run the Docker containers:
```bash
Make build
```
or use
```bash
docker compose -f local.yml up --build -d --remove-orphans
```
4. Access the API locally at http://localhost:8080.
## Usage
After setting up the project locally, you can interact with the API using tools like curl, httpie, or API clients like Postman. Refer to the API documentation for available endpoints, request formats, and responses.
## License
This project is licensed under the MIT License.
## Acknowledgments
This project wouldn't have been possible without the invaluable resources and documentation provided by the following:
- [Django Documentation](https://docs.djangoproject.com/): The official documentation for the Django web framework, which guided us in building the backend of our project.
- [Django Rest Framework Documentation](https://www.django-rest-framework.org/): The comprehensive documentation for the Django Rest Framework, helping us create robust and user-friendly APIs.
- [Docker Documentation](https://docs.docker.com/): The Docker documentation was crucial in containerizing our application and making it portable and scalable.