D-Codex Cookiecutter

This project can setup a D-Codex site using Cookiecutter Django

Usage

First, get Cookiecutter.

$ pip install cookiecutter

Now run it against this repo:

$ cookiecutter https://github.com/rbturnbull/dcodex-cookiecutter

You'll be prompted for some values. Provide them, then a Django project using dcodex will be created for you.

Warning: After this point, change 'Robert Turnbull', 'dcodex_family_13', etc to your own information.

Answer the prompts with your own desired options. For example:

project_name [My DCodex Project]: DCodex Family 13
project_slug [dcodex_family_13]: dcodex_f13
description [A brief description my DCodex project.]: A D-Codex project to display the manuscripts of family 13
author_name [Robert Turnbull]: Robert Turnbull
domain_name [example.com]: f13.d-codex.net
email [robert.turnbull@dcodex.net]: rob@robturnbull.com
version [0.1.0]:
Select open_source_license:
1 - Apache Software License 2.0
2 - MIT
3 - BSD
4 - GPLv3
5 - Not open source
Choose from 1, 2, 3, 4, 5 [1]:
timezone [Australia/Melbourne]:
windows [n]:
use_pycharm [n]:
use_docker [y]:
Select postgresql_version:
1 - 12.3
2 - 11.8
3 - 10.8
4 - 9.6
5 - 9.5
Choose from 1, 2, 3, 4, 5 [1]:
Select js_task_runner:
1 - None
2 - Gulp
Choose from 1, 2 [1]:
Select cloud_provider:
1 - AWS
2 - GCP
3 - None
Choose from 1, 2, 3 [1]:
Select mail_service:
1 - Other SMTP
2 - Mailgun
3 - Amazon SES
4 - Mailjet
5 - Mandrill
6 - Postmark
7 - Sendgrid
8 - SendinBlue
9 - SparkPost
Choose from 1, 2, 3, 4, 5, 6, 7, 8, 9 [1]:
use_async [n]:
use_drf [y]:
custom_bootstrap_compilation [n]:
use_compressor [y]:
use_celery [y]:
use_mailhog [n]:
use_sentry [n]:
use_whitenoise [y]:
use_heroku [n]:
Select ci_tool:
1 - None
2 - Travis
3 - Gitlab
4 - Github
Choose from 1, 2, 3, 4 [1]:
keep_local_envs_in_vcs [y]:
debug [n]:
dcodex_url_prefix [dcodex]:
use_dcodex_bible [n]: y
use_dcodex_lectionary [n]:
use_dcodex_collation [n]:
use_dcodex_variants [n]:
[SUCCESS]: Project initialized, keep up the good work!

Enter the project and take a look around:

$ cd dcodex_f13/
$ ls

Create a git repo and push it there:

$ git init
$ git add .
$ git commit -m "Initial commit for dcodex_f13"
$ git remote add origin git@github.com:rbturnbull/dcodex_f13.git
$ git push -u origin master

Look at the documentation for the dcodex packages you installed to find out more.

• https://github.com/rbturnbull/dcodex
• https://github.com/rbturnbull/dcodex_bible
• https://github.com/rbturnbull/dcodex_lectionary
• https://github.com/rbturnbull/dcodex_collation
• https://github.com/rbturnbull/dcodex_variants

For local development, see the following:

• Developing locally
• Developing locally using docker

Find out more

For more information on the Django setup, see the Cookiecutter Django documentation and also Daniel Feldroy and Audrey Feldroy's book Two Scoops of Django.

Here are some other articles which discuss using Cookiecutter Django

• Using cookiecutter-django with Google Cloud Storage - Mar. 12, 2019
• cookiecutter-django with Nginx, Route 53 and ELB - Feb. 12, 2018
• cookiecutter-django and Amazon RDS - Feb. 7, 2018
• Using Cookiecutter to Jumpstart a Django Project on Windows with PyCharm - May 19, 2017
• Exploring with Cookiecutter - Dec. 3, 2016
• Introduction to Cookiecutter-Django - Feb. 19, 2016
• Django and GitLab - Running Continuous Integration and tests with your FREE account - May. 11, 2016
• Development and Deployment of Cookiecutter-Django on Fedora - Jan. 18, 2016
• Development and Deployment of Cookiecutter-Django via Docker - Dec. 29, 2015
• How to create a Django Application using Cookiecutter and Django 1.8 - Sept. 12, 2015

Code of Conduct

Everyone interacting in the Cookiecutter project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PyPA Code of Conduct.