Drf Quickstart

screenshot of Drf Quickstart

Drf Quickstart

Django and Django Rest Framework boilerplate project

Overview:

This project is a sample API built with Django and DRF (Django Rest Framework). It allows users to store and retrieve people's birthdays. The project has a well-organized structure with main folders for the API code, configuration files, and tests. It also includes some boilerplate utility files for Docker, Makefile, and code linting.

Features:

  • API Code: Contains the main code for the API, including views (controllers), models (active records), and other modules.
  • Configuration: Contains Django settings, URL routing, and relevant configuration files.
  • Tests: A dedicated folder to write and store the tests for the project.
  • Dockerfile: A Dockerfile is included for easy deployment and containerization of the project.
  • Makefile: Provides utility commands for building and running the project.
  • Setup.cfg: Allows configuration of code linting and other related settings.

Installation:

To run this project locally, you need to install poetry, which is the dependency management tool used in this project. Follow the steps below to install the required dependencies and run the project with a SQLite database.

  1. Install poetry:
# command to install poetry
  1. Install project dependencies:
# command to install project dependencies using poetry
  1. Run the project locally:
# command to start the project locally with a SQLite database
  1. Once the project is running, you can start making API calls to the existing endpoints. You can refer to the tests folder for detailed information on the available endpoints.

Summary:

This project is a simple API built with Django and DRF for storing and retrieving people's birthdays. It follows a well-organized structure and includes utility files for Docker, Makefile, and code linting configuration. To run the project locally, you need to install poetry and dependencies, and then start the project with a SQLite database.