https://github.com/satheesh1997/django-3.x-api-boilerplate

Boilerplate code to create a api service using django 3.x
https://github.com/satheesh1997/django-3.x-api-boilerplate

boilerplate-template django-application django-rest-framework pipenv precommit-hooks python3

Last synced: 3 months ago
JSON representation

Boilerplate code to create a api service using django 3.x

• Host: GitHub
• URL: https://github.com/satheesh1997/django-3.x-api-boilerplate
• Owner: satheesh1997
• Created: 2020-12-07T16:37:08.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2020-12-25T07:27:50.000Z (over 4 years ago)
• Last Synced: 2025-02-01T18:43:55.900Z (5 months ago)
• Topics: boilerplate-template, django-application, django-rest-framework, pipenv, precommit-hooks, python3
• Language: Python
• Homepage:
• Size: 12.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Django 3.x Api Boilerplate

This template has boilerplate code to create a django api service from scratch. Just clone the template and start writing your app logics.

## Supports

1. Django 3.3

2. Django rest framework

3. ipython

4. ipdb

5. pre-commit

6. pipenv

## PreComit Hooks

This template has a inbuilt precommit hooks support that will lint, format and do security checks on the staged files. To setup precommit hook run `precommit install`. The hooks present in the project can be found at .pre-commit-config.yaml file.

## How to setup?

1. Create a new project directory and change to project directory

2. `git clone https://github.com/satheesh1997/django-3.x-api-boilerplate.git . `.

3. `rm -rf .git`, once removed create a repo on your github.

4. `git init`

5. `git remote add origin `

6. `git add .`

7. `git commit -m 'Initial commit'`

8. `git push -u origin master`

## How to start the server?

This template uses pipenv for python dependency management. So to start the server do `pipenv install` to install all the packages. Once done, do `pipenv shell` to activate the python environment and run `./manage.py runserver`.

To know more about pipenv refer https://realpython.com/pipenv-guide/.

## Project Structure

This is the structure on how the files and folders are structures in this template.

[![Folder tree](https://i.ibb.co/WtMpknr/Screenshot-from-2020-12-25-12-52-36.png "Folder tree")](https://i.ibb.co/WtMpknr/Screenshot-from-2020-12-25-12-52-36.png "Folder tree")