boilerplate's Introduction

Boilerplate apps

What is this?

Django boilerplate apps are a collection of apps that can be used to quickly. get started with a new Django project. They are designed to be used as a base for a new project. They are not designed to be used as a standalone app.

Why?

I have found that I often start a new project with the same basic setup. I have a base project that I use as a starting point. I then copy the apps I need from that project into the new project. This is a pain and I wanted to make it easier.

Setup instructions

Clone the repo
```
git clone ...

cd boilerplate
```
Run in Docker (see below)
Run in Local (see below)
Npm install
```
npm install
```
Run npm build
```
npm run build
```

Setup Django Boilerplate with Docker

Build and run the docker container
```
docker-compose up -d --build
```

Run the migrations

docker-compose exec web python manage.py migrate

Create a superuser

docker-compose exec web python manage.py createsuperuser

Run the tests

docker-compose exec web python manage.py test

Run the server

docker-compose exec web python manage.py runserver

Setup Django Boilerplate with Local

Create a virtual environment
```
python3 -m venv venv
```
Activate the virtual environment
```
source venv/bin/activate
```
Install the requirements
```
pip install -r requirements.txt
```
Setup Environment Variables and change values as needed
```
cp .env.example .env
```
Run the migrations
```
python manage.py migrate
```
Create a superuser
```
python manage.py createsuperuser
```
Run the tests
```
python manage.py test
```
Run the server
```
python manage.py runserver
```

Recommend Projects