dmitlenko/buildman-dj

Buildman

Development

Requirements

• Python >= 3.12
• Poetry >= 1.7.1
• Docker Desktop >= 25.0.0

Setup

1. Clone the repository

git clone https://github.com/dmitlenko/buildman-dj.git

2. Install the dependencies

poetry install

3. Setup the development settings

make dev-settings

4. Run the development database

make up-dependencies

5. Run the migrations

make migrate

6. Run the development server

make runserver

Creating a new app

1. Create a new app

make app

2. Enter the app name

Enter app name: <app_name>

3. Add the app to the INSTALLED_APPS in the buildman/project/settings/base.py

INSTALLED_APPS = [
    ...
    'buildman.apps.<app_name>',
    ...
]

Available commands

• make runserver - Run the development server
• make migrate - Run the migrations
• make migrations - Create a new migration
• make shell - Run the Django shell
• make up-dependencies - Run the development database
• make dev-setting - Setup the development settings

Deployment

Deploy using Docker

1. Build the Docker image

docker componse build

2. Setup the environment variables

cp .env.example .env

3. Run the Docker container

docker-compose up

License

This project is licensed under the MIT License - see the LICENSE file for details.