Django Starter Template

Description

Django Starter is a simple Skeleton to start with a Django project.

Installation

Requirements

(click each one for install guide)

Setup Process

  1. Clone the git: git clone https://github.com/NumanIbnMazid/django_starter.git

  2. Go into the new directory: cd django_starter

  3. Install the required dependencies.

    • Install Dependencies Using Pip

      • Run pip install -r requirements.txt, this will install all the required dependencies.

        Please choose to (w)ipe if asked for this:

        The plan is to install the git repository https://github.com/xxxx
        What to do?  (i)gnore, (w)ipe, (b)ackup
        
    • Install Dependencies Using Poetry

      • Run poetry install, this will install all the required dependencies.
    ![N:B: Replace `python` with `poetry run python` if using poetry. For example: `poetry run python manage.py runserver`]
  4. Create a .env file and provide required environment variables using the template .env.example or run python utils/generate_env.py to automatically generate the .env file.

  5. Run python manage.py makemigrations and python manage.py migrate, this will create the database tables

  6. Run python manage.py collectstatic, this will collect all static files

  7. Run python manage.py runserver
    this should start the project on port 8000.

  8. Open the app on browser by navigating the url http://127.0.0.1:8000

Features

  • Easy Installation
  • Standard Project Structure
  • Example Landing Page using Bootstrap 5
  • Setup script
  • Dockerized
  • I18N Support

Author

GitHub

View Github