Xedge>> django-postgres-dokku>> 返回
项目作者： altixco

项目描述 ：
Django 3.1 + Postgres 11 + Dokku config (Production Ready)
高级语言： Python
项目地址: git://github.com/altixco/django-postgres-dokku.git
创建时间： 2019-09-27T23:47:52Z
项目社区：https://github.com/altixco/django-postgres-dokku
开源协议：
下载


project_name

Django 3.1.1 + Postgres 11 + Dokku config (Production Ready)

Documentation

Directory Tree

  2. ├── main (Main application of the project, use it to add main templates, statics and root routes)
  3. │   ├── fixtures
  4. │   │   ├── dev.json (Useful dev fixtures, by default it creates an `admin` user with password `admin`)
  5. │   │   └── initial.json (Initial fixture loaded on each startup of the project)
  6. │   ├── migrations
  7. │   ├── static (Add here the main statics of the app)
  8. │   ├── templates (Add here the main templates of the app)
  9. │   ├── admin.py
  10. │   ├── apps.py
  11. │   ├── models.py (Main models like City, Config)
  12. │   ├── tests.py (We hope you will put some tests here :D)
  13. │   ├── urls.py (Main urls, place the home page here)
  14. │   └── views.py
  15. ├── media
  16. ├── project_name
  17. │   ├── settings
  18. │   │   ├── partials
  19. │   │   │   └── util.py (Useful functions to be used in settings)
  20. │   │   ├── common.py (Common settings for different environments)
  21. │   │   ├── development.py (Settings for the development environment)
  22. │   │   └── production.py (Settings for production)
  23. │   ├── urls.py
  24. │   └── wsgi.py
  25. ├── scripts
  26. │   ├── command-dev.sh (Commands executed after the development containers are ready)
  27. │   └── wait-for-it.sh (Dev script to wait for the database to be ready before starting the django app)
  28. ├── .env enviroment variables (ogmpred bu git)
  29. ├── .env.example Example environment file
  30. ├── static
  31. ├── static
  32. ├── Dockerfile (Instructions to create the project image with docker)
  33. ├── Makefile (Useful commands)
  34. ├── Procfile (Dokku or Heroku file with startup command)
  35. ├── README.md (This file)
  36. ├── app.json (Dokku deployment configuration)
  37. ├── docker-compose.yml (Config to easily deploy the project in development with docker)
  38. ├── manage.py (Utility to run most django commands)
  39. ├── requirementes.txt (Python dependencies to be installed)
  40. └── requirements-dev.txt (Python dev dependencies to be installed)

How to install the template

Clone the repository, and update your origin url: 

  1. git clone https://github.com/altixco/django-postgres-dokku project_name
  2. cd project_name

Merge the addons required by your project (Optional):

  1. git merge origin/rest
  2. git merge origin/webpack
  3. git merge origin/push-notifications

Rename your project files and directorys:

  1. make name=project_name init

Info: Make is required, for mac run brew install make

After this command you can already delete the init command inside the Makefile

The command before will remove the .git folder so you will have to initialize it again:

  1. git init
  2. git remote add origin <repository-url>

How to run the project

⚙️ Setup

Before running the application, copy the environment file:

  1. cp .env.example .env
  4. The project use docker, so just run:

docker-compose up

  2. > If it's first time, the images will be created. Sometimes the project doesn't run at first time because the init of postgres, just run again `docker-compose up` and it will work.
  4. *Your app will run in url `localhost:8000`*
  6. To recreate the docker images after dependencies changes run:

docker-compose up —build

  2. To remove the docker containers including database (Useful sometimes when dealing with migrations):

docker-compose down

  2. ### Accessing Administration
  4. The django admin site of the project can be accessed at `localhost:8000/admin`
  6. By default the development configuration creates a superuser with the following credentials:

Username: admin
Password: admin

  2. ## Production Deployment: ##
  4. The project is dokku ready, this are the steps to deploy it in your dokku server:
  6. #### Server Side: ####
  8. > This docs does not cover dokku setup, you should already have configured the initial dokku config including ssh keys
  10. Create app and configure postgres:

dokku apps:create project_name
dokku postgres:create project_name
dokku postgres:link project_name project_name

  2. > If you don't have dokku postgres installed, run this before:
  3. > `sudo dokku plugin:install https://github.com/dokku/dokku-postgres.git`
  5. Create the required environment variables:

dokku config:set project_name ENVIRONMENT=production DJANGO_SECRET_KEY=….

  2. Current required environment variables are:
  4. * ENVIRONMENT
  5. * DJANGO_SECRET_KEY
  6. * EMAIL_PASSWORD
  8. Use the same command to configure secret credentials for the app
  10. #### Local Side: ####
  12. Configure the dokku remote:

git remote add production dokku@:project_name

  2. Push your changes and just wait for the magic to happens :D:

git push production master

  2. Optional: To add SSL to the app check:
  3. https://github.com/dokku/dokku-letsencrypt
  5. Optional: Additional nginx configuration (like client_max_body_size) should be placed server side in:

/home/dokku//nginx.conf.d/.conf
```

Further dokku configuration can be found here: http://dokku.viewdocs.io/dokku/