Skip to content

jared-jewitt/backend-booster-django-postgresql

Repository files navigation

Backend Booster - Django + PostgreSQL

This codebase is a Django + PostgreSQL boilerplate. It is intended to be used as a Booster for my Launchpad. However, that being said, it can still be used completely on its own.

Requirements:

Features:

  • 🐍 Python 3.9
  • 🐍 Django 3
  • ⚙️ Django Rest Framework 3
  • ⬛ Black for consistent code style
  • 👀 Lint your code with Pylint
  • 🔃 pre-commit for code quality assurance

Developers:


🏃 Getting Started

Run the backend via the command below, then visit the API at http://localhost:5000

make up

⌨️ Commands

Make
Command Description
make up Launches the database + server
make down Removes the database + server containers
make nuke Purges all database + server containers, images, networks, volumes
make bash Shells into the server to run one-off commands. e.g. python manage.py test
Python (use these after running make bash)
Command Description
python manage.py test Runs the suite of Django tests
python -m pylint **/*.py Runs Pylint to check for linting errors
python -m black **/*.py Runs Black to fix linting errors

🚀 Deployment

Instructions here.

⚖️ License

Code released under the MIT License.