seedorf

Introduction

Find sporty spots and sporty people near you.

:License: MIT

Requirements

python = 3.6.4
pipenv = 11.7.2
docker =
docker-compose =
postgresql = 9.6.8
terraform = v0.11.3
git-crypt = 0.6.0

Settings

Moved to settings_.

settings

Git Crypt

Install

$ brew install git-crypt

Introduction

Git crypt is used encrypt the sensitive data (e.g. *.tfstate). The files encrypted by git-crypt are defined in .gitattributes

Generate a new GPG key

Github Article

Adding new contributors

$ gpg --list-secret-keys --keyid-format LONG
/Users/hubot/.gnupg/secring.gpg
------------------------------------
sec   4096R/3AA5C34371567BD2 2016-03-10 [expires: 2017-03-10]
uid                          Hubot
ssb   4096R/42B317FD4BA89E7A 2016-03-10

$ git-crypt add-gpg-user --trusted 3AA5C34371567BD2

Decrypting

$ cd seedorf
$ git-crypt unlock

Terraform

Settings

Define the following environment variables

$ export TF_VAR_aws_root_access_key_id=XXX
$ export TF_VAR_aws_root_access_key_secret=XXX

Initialize

Initialize terraform to download AWS provider plugin

$ cd terraform
$ terraform init

Commands

AWS Planning

VPC by Region

Region	CIDR	Start IP	End IP	Max IPs	Env
eu-central-1	10.0.0.0/16	10.0.0.0	10.0.255.255	65536	PRD
eu-central-1	10.1.0.0/16	10.1.0.0	10.1.255.255	65536	STG
eu-central-1	10.2.0.0/16	10.2.0.0	10.2.255.255	65536	TST
eu-central-1	10.3.0.0/16	10.3.0.0	10.3.255.255	65536	DEV
eu-west-1	10.10.0.0/16	10.10.0.0	10.10.255.255	65536	PRD
eu-west-1	10.11.0.0/16	10.11.0.0	10.11.255.255	65536	STG
eu-west-1	10.12.0.0/16	10.12.0.0	10.12.255.255	65536	TST
eu-west-1	10.13.0.0/16	10.13.0.0	10.13.255.255	65536	DEV

VPC Subnet by Availability Zone

Region	Availability Zone	CIDR	Start IP	End IP	Total IPs	Env
eu-central-1	eu-central-1a	10.0.0.0/20	10.0.0.0	10.0.15.255	4096	PRD
eu-central-1	eu-central-1b	10.0.16.0/20	10.0.16.0	10.0.31.255	4096	PRD
eu-central-1	eu-central-1c	10.0.32.0/20	10.0.32.0	10.0.47.255	4096	PRD
eu-central-1	eu-central-1a	10.1.0.0/20	10.1.0.0	10.1.15.255	4096	STG
eu-central-1	eu-central-1b	10.1.16.0/20	10.1.16.0	10.1.31.255	4096	STG
eu-central-1	eu-central-1c	10.1.32.0/20	10.1.32.0	10.1.47.255	4096	STG
eu-central-1	eu-central-1a	10.2.0.0/20	10.2.0.0	10.2.15.255	4096	TST
eu-central-1	eu-central-1b	10.2.16.0/20	10.2.16.0	10.2.31.255	4096	TST
eu-central-1	eu-central-1c	10.2.32.0/20	10.2.32.0	10.2.47.255	4096	TST
eu-central-1	eu-central-1a	10.3.0.0/20	10.3.0.0	10.3.15.255	4096	DEV
eu-central-1	eu-central-1b	10.3.16.0/20	10.3.16.0	10.3.31.255	4096	DEV
eu-central-1	eu-central-1c	10.3.32.0/20	10.3.32.0	10.3.47.255	4096	DEV
eu-west-1	eu-west-1a	10.10.0.0/20	10.10.0.0	10.10.15.255	4096	PRD
eu-west-1	eu-west-1b	10.10.16.0/20	10.10.16.0	10.10.31.255	4096	PRD
eu-west-1	eu-west-1c	10.10.32.0/20	10.10.32.0	10.10.47.255	4096	PRD
eu-west-1	eu-west-1a	10.11.0.0/20	10.11.0.0	10.11.15.255	4096	STG
eu-west-1	eu-west-1b	10.11.16.0/20	10.11.16.0	10.11.31.255	4096	STG
eu-west-1	eu-west-1c	10.11.32.0/20	10.11.32.0	10.11.47.255	4096	STG
eu-west-1	eu-west-1a	10.12.0.0/20	10.12.0.0	10.12.15.255	4096	TST
eu-west-1	eu-west-1b	10.12.16.0/20	10.12.16.0	10.12.31.255	4096	TST
eu-west-1	eu-west-1c	10.12.32.0/20	10.12.32.0	10.12.47.255	4096	TST
eu-west-1	eu-west-1a	10.13.0.0/20	10.13.0.0	10.13.15.255	4096	DEV
eu-west-1	eu-west-1b	10.13.16.0/20	10.13.16.0	10.13.31.255	4096	DEV
eu-west-1	eu-west-1c	10.13.32.0/20	10.13.32.0	10.13.47.255	4096	DEV

Docker

Commands

Build and run local docker compose setup

$ docker-compose -f docker_compose_local.yml up -d

Stop setup

$ docker-compose -f docker_compose_local.yml down

Create superuser

$ docker-compose -f docker_compose_local.yml run --rm django python manage.py createsuperuser --username admin --email admin@sportyspots.com

Create Sports Fixtures

$  docker-compose --file docker_compose_local.yml run --rm django ./manage.py loaddata seedorf/sports/fixtures/sports.json

Find AWS ECR repository Uri

$ aws ecr describe-repositories | jq '.repositories | .[] | .repositoryUri'

Create production image for ECR

$ docker build -t sportyspots --build-arg GIT_COMMIT=$(git log -1 --format="%H") -f compose/production/django/Dockerfile .

Tag image with AWS Uri

$ docker tag sportyspots XXXXXX.dkr.ecr.eu-central-1.amazonaws.com/sportyspots

Get login token from ecr if required

$ $(aws ecr get-login --no-include-email)

Django Frontend URLs'

Basic Commands

Setting Up Your Users

To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.
To create an superuser account, use this command::

$ python manage.py createsuperuser

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report::

$ coverage run manage.py test
$ coverage html
$ open htmlcov/index.html

Running test

$ PIPENV_DOTENV_LOCATION=.env.test pipenv run ./manage.py test

Running tests with py.test

$ PIPENV_DOTENV_LOCATION=.env.test pipenv run pytest

Live reloading and Sass CSS compilation

Moved to Live reloading and SASS compilation_.

Live reloading and SASS compilation

Celery

This app comes with Celery.

To run a celery worker:

cd seedorf
celery -A seedorf.taskapp worker -l info

Please note: For Celery's import magic to work, it is important where the celery commands are run. If you are in the same folder with manage.py, you should be right.

Email Server

In development, it is often nice to be able to see emails that are being sent from your application. For that reason local SMTP server MailHog_ with a web interface is available as docker container.

mailhog

Container mailhog will start automatically when you will run all docker containers. Please check cookiecutter-django Docker documentation_ for more details how to start all containers.

With MailHog running, to view messages that are sent by your application, open your browser and go to http://127.0.0.1:8025

Sentry

Sentry is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself. The system is setup with reasonable defaults, including 404 logging and integration with the WSGI application.

You must set the DSN url in production.

Deployment

The following details how to deploy this application.

Docker

See detailed cookiecutter-django Docker documentation_.

cookiecutter-django Docker documentation

Name		Name	Last commit message	Last commit date
Latest commit History 612 Commits
.envs		.envs
.git-crypt		.git-crypt
ansible		ansible
appwork		appwork
compose		compose
config		config
seedorf		seedorf
terraform		terraform
.coveragerc		.coveragerc
.dockerignore		.dockerignore
.editorconfig		.editorconfig
.gitattributes		.gitattributes
.gitignore		.gitignore
.nvmrc		.nvmrc
.prettierignore		.prettierignore
.prettierrc.yml		.prettierrc.yml
.pylintrc		.pylintrc
.python-version		.python-version
.pyup.yml		.pyup.yml
.travis.yml		.travis.yml
CONTRIBUTORS.txt		CONTRIBUTORS.txt
LICENSE		LICENSE
Pipfile		Pipfile
Pipfile.lock		Pipfile.lock
README.md		README.md
docker_compose_local.yml		docker_compose_local.yml
docker_compose_production.yml		docker_compose_production.yml
fabfile.py		fabfile.py
manage.py		manage.py
package.json		package.json
pyproject.toml		pyproject.toml
pytest.ini		pytest.ini
setup.cfg		setup.cfg
yarn.lock		yarn.lock

License

SportySpots/seedorf

Folders and files

Latest commit

History

Repository files navigation

seedorf

Introduction

Requirements

Settings

Git Crypt

Install

Introduction

Generate a new GPG key

Adding new contributors

Decrypting

Terraform

Settings

Initialize

Commands

AWS Planning

VPC by Region

VPC Subnet by Availability Zone

Docker

Commands

Django Frontend URLs'

API Docs

Django Admin

Django API

Mailhog

Basic Commands

Setting Up Your Users

Test coverage

Running test

Running tests with py.test

Live reloading and Sass CSS compilation

Celery

Email Server

Sentry

Deployment

Docker

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Contributors 4

Languages

Packages