https://github.com/codemonauts/django-boilerplate

A good starting point for your next Django project
https://github.com/codemonauts/django-boilerplate

django hacktoberfest

Last synced: about 4 hours ago
JSON representation

A good starting point for your next Django project

• Host: GitHub
• URL: https://github.com/codemonauts/django-boilerplate
• Owner: codemonauts
• Created: 2020-05-24T18:03:42.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-12-06T04:25:21.000Z (almost 2 years ago)
• Last Synced: 2024-04-17T02:03:20.432Z (7 months ago)
• Topics: django, hacktoberfest
• Language: Python
• Homepage:
• Size: 300 KB
• Stars: 4
• Watchers: 4
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Django-Boilerplate

Use this as a starting point for new Django projects. This boilerplate is intendet to represent our way of developing

Djang so we made some decisions in this repository:

    - Custom user model

    - Use pug instead of plain HTML

    - Move apps into the project folder

    - User one globale template folder for all apps

    - Use AWS S3 to store assets in production

    - Different settings files for different stages

    - Docker/Docker-Compose for local development

    - gulp.js for css/js/image processing

# Usage

Make sure you have Docker and docker-compose installed. Then execute the following steps to create a project with the

name *myproject*:

```

mkdir myproject && cd myproject

django-admin startproject --template https://github.com/codemonauts/django-boilerplate/archive/main.zip --name=docker-compose.yml myproject .

docker-compose up

```

Your new Django installation should now be reachable at [localhost:8000](http://localhost:8000)

## Install new dependencies

```

echo "libraryname" >> requirements.txt

docker-compose exec web pip install -r requirements.txt

```

## Run Django comamands with manage.py

```

docker-compose exec web ./manage.py 

```

## Import DB dump

The dump must be located inside the project dir

```

docker-compose exec db import 

```

## Create a DB dump

```

docker-compose exec db dump

```