Django Rest Framework Boilerplate

Overview:

The django-rest-framework-boilerplate is a simple boilerplate for Django and Django Rest Framework. It provides a set of pre-configured features and functionalities to help developers quickly set up a Django Rest Framework project.

Features:

• Users API CRUD endpoints
• DRF JWT Authentication
• Docker configurations
• Document folder structure
• Static/media and templates configuration
• Integration of Material UI and React JS on templates

Using Docker Compose:

1. Clone the repository: $ git clone https://github.com/p8ul/django-rest-framework-boilerplate
2. Navigate to the project directory: $ cd django-rest-framework-boilerplate
3. Run the Docker Compose command: $ docker-compose up

Without Docker:

1. Before proceeding, ensure that Python is installed on your computer. If not, you can download Python here.
2. Install virtualenv globally if not already installed: $ pip install virtualenv
3. Clone the repository to your preferred directory.
4. Create a virtual environment: $ virtualenv env
5. Activate the virtual environment:
   • On Windows: $ env\Scripts\activate
   • On Linux/Mac: $ source env/bin/activate
6. Install the dependencies: $ pip install -r requirements.txt
7. Run the following commands to setup the database:
   • $ python manage.py makemigrations
   • $ python manage.py migrate
8. Create a superuser: $ python manage.py createsuperuser

Summary:

The django-rest-framework-boilerplate is a convenient solution for quickly setting up a Django Rest Framework project. It provides pre-configured features such as CRUD endpoints for users, JWT authentication, and Docker configurations. The installation process is straightforward, with options for using Docker Compose or running the project without Docker. Overall, this boilerplate can save developers time and effort in setting up a Django Rest Framework project.