rodgomes / drf-quickstart

Django and Django Rest Framework boilerplate project

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Sample project with Django + DRF

Django CI GitHub tag License Python 3.9 code style - black

This project contains a simple API that is used to store people's birthdays.

Structure

Main folders are:

  • src/api: where the main code lives, including views (controllers), models (active records) and any other modules you would like.
  • src/config: Djago settings, urls wsgi and asgi files (and any other configuration file you would like to put)
  • tests: Where your tests will live

The project also includes some boilerplate utility files such as: Dockerfile and respective entrypoint.sh, Makefile with some utilities commands and setup.cfg for configuring linting, etc.

Basic installation and usage

You need poetry in order to run this project locally. To install the dependencies

poetry install

Then execute the commands below to run locally with sqlite Database.

make migrate
make run

You should see the message below and can start calling the existing endpoints (see tests folder for details)

Starting development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.

About

Django and Django Rest Framework boilerplate project

License:Apache License 2.0


Languages

Language:Python 87.5%Language:Makefile 9.1%Language:Dockerfile 2.4%Language:Shell 1.0%