README.MD

Django Template

Introduction

This project is a template for a Django application that can be used as a base for new projects. It includes basic configurations and sample files to facilitate a quick start.

Prerequisites

• Python 3.8 or higher
• Poetry for dependency management
• Virtual environment (optional, but recommended)
• Django 5.0.6 or higher

How to Run the Project?

1. Create a New Project Directory

1. Create a new directory for your project and navigate to it:

   mkdir myproject
   cd myproject

2. Set Up the Django Project

1. Set up your project using the copied template URL:

   django-admin startproject project_name . --template https://github.com/AdamWiercioch95/django_template/archive/refs/heads/template.zip

   Replace project_name with the desired name for your project.

3. Install Dependencies

1. Use Poetry to install the project dependencies:

   poetry install

4. Open the Project

1. Open your project in your preferred code editor.

5. Configure Environment Files

1. Navigate to the env directory and create a .env file based on the .env-default file:

   cp env/.env-default env/.env

2. Edit the env/.env file to fit your environment (e.g., database settings, API keys, etc.).

6. Adjust Test Configurations

1. Open the pytest.ini file and replace {{ project_name }} with your project name:

   [pytest]
   DJANGO_SETTINGS_MODULE = {{ project_name }}.settings

   For example, if your project name is myproject, it should be:

   [pytest]
   DJANGO_SETTINGS_MODULE = myproject.settings

Additional Information

• To run the Django development server, use:

  poetry run python manage.py runserver

• To run tests, use:

  poetry run pytest

Useful Links

• Django Documentation
• Poetry Documentation