Welcome to django_starter! This is a boilerplate designed to help you quickly set up an API using Django 5. With built-in support for JWT authentication, Celery for task management, Redis for caching, and Docker for easy deployment, you can start building your application without hassle.
- Django 5 Framework: The latest version of Django to build your application.
- JWT Authentication: Secure user authentication using JSON Web Tokens.
- Celery: Use Celery for running background tasks without interrupting your main application.
- Redis: Enjoy quick data access with Redis caching.
- Docker Support: Simplify your development and deployment process with Docker.
- PostgreSQL Database: A reliable database option for your application data.
- Nginx: Use Nginx as a reverse proxy for better performance.
- Gunicorn: A Python WSGI HTTP server for a robust web serving solution.
- Django REST Framework: Build RESTful APIs quickly and efficiently.
To run django_starter, ensure your system meets these requirements:
- Operating System: Windows, macOS, or Linux
- Docker: Version 20.10 or later
- Docker Compose: Version 1.27.0 or later
- PostgreSQL: Version 12 or later
-
Visit the Releases Page: Go to the Releases Page to find the latest version of django_starter.
-
Download the Release: Look for the ".zip" or ".tar.gz" file under the latest version. Click on it to download the application files to your computer.
-
Extract the Files: Once the download is complete, locate the downloaded file and extract it. You can do this by right-clicking on the file and selecting "Extract" or using a program like WinRAR or 7-Zip.
-
Set Up Docker: Ensure Docker is installed on your system. If not, you can download it from the Docker website.
-
Run Docker Compose:
- Open a terminal or command prompt.
- Navigate to the folder where you extracted the django_starter files.
- Run the command
docker-compose up.
-
Access the Application: Once the containers are running, you can access your API by opening a web browser and going to
http://localhost:8000.
After following the installation steps, your application should be running on your local machine. You can interact with it using tools like Postman or your web browser by making requests to the API endpoints.
- Authenticate:
POST /api/token/to obtain JWT tokens. - Get Data:
GET /api/data/to retrieve data from your application. - Background Tasks:
POST /api/tasks/to create background tasks using Celery.
Detailed documentation for django_starter is available in the docs folder included in the download. This documentation covers various aspects like configuration, available API endpoints, and how to extend your application.
If you need help, feel free to raise an issue in the GitHub repository. Community members, including the repository maintainer, actively monitor issues and will help you with any questions.
We welcome contributions! If you wish to contribute to django_starter, please fork the repository and make a pull request. Here's how:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them with clear messages.
- Push to your branch and create a pull request.
Thank you for considering contributing to django_starter!
Keep an eye on the Releases Page for updates: Releases Page.
Enjoy building your API with django_starter!