Skip to content

ouhammmourachid/django-quicker

Repository files navigation

Django Quicker

License: MIT ruff badge Backend Framework Database

Django Quicker is a Django template that helps you to start your Django project quickly. It includes a lot of features that you will need in your project.

Features

  • Django 5.1
  • Django REST framework
  • PostgreSQL
  • Docker
  • Docker Compose
  • Github Actions
  • linters (ruff,mypy,codespell)

Getting Started

Prerequisites

Installation

  1. Clone the repo
git clone https://github.com/ouhammmourachid/django-quicker.git
cd django-quicker
  1. get help command
$ make help
run 'make' to run the the django server

or 'make <target>' where <target> is one of the following:

  install                               Install the project dependencies
  install-pre-commit                    Install pre-commit hooks
  lint                                  Run pre-commit hooks

  run-server                            Run the django server
  migrate                               Apply migrations
  migrations                            Create migrations
  superuser                             Create superuser
  app <name>                            Create a new app

  local-settings                        Create local settings file
  update                                Install dependencies, apply migrations and install pre-commit hooks
  up-dependencies-only                  Up only the dependencies
  collectstatic                         Collect static files

  docker/build                          Build the docker images
  docker/up                             Up the docker containers
  build-up                              Build and up the docker containers
  docker/down                           Down the docker containers

  install/cargo                         Install cargo
  install/mdbook                        Install mdbook
  docs/build                            Build the documentation
  docs/serve                            Serve the documentation

For more information, see the README.md file.
  1. Install the project dependencies
make install
  1. Create a local settings file
make local-settings
  1. Apply migrations
make migrate
  1. Create a superuser
make superuser
  1. Run the Django server
make run-server
  1. Open your browser and go to http://localhost:8000

  2. You can access the Django admin panel by going to http://localhost:8000/admin

  3. You can access the Django REST framework by going to http://localhost:8000/api

License

Distributed under the MIT License.

Contact

If you have any questions or want to get in touch, you can reach out to me at rachidouhammou21@gmail.com.