bootstrap

Author: quorth0n

.gitignore

@@ -0,0 +1,138 @@
+### Django ###
+*.log
+*.pot
+*.pyc
+__pycache__/
+local_settings.py
+db.sqlite3
+media
+
+# If your build process includes running collectstatic, then you probably don't need or want to include staticfiles/
+# in your Git repository. Update and uncomment the following line accordingly.
+project/static/
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+
+# Django stuff:
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+### Python Patch ###
+.venv/
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json

.travis.yml

@@ -0,0 +1,16 @@
+language: python
+
+sudo: required
+
+python:
+  - "3.6"
+
+services:
+  - docker
+
+install:
+  - docker-compose pull
+  - docker-compose build
+
+script:
+  - docker-compose run --service-ports web sh wait_for_postgres.sh python manage.py test

Dockerfile

@@ -0,0 +1,25 @@
+FROM python:3.6-alpine
+
+LABEL maintainer="whirish <[email protected]>"
+
+ENV PYTHONUNBUFFERED 1
+
+RUN sed -i -e 's/v3\.7/edge/g' /etc/apk/repositories && \
+    apk upgrade --update-cache --available
+
+RUN apk update && \
+    apk add --virtual build-deps gcc python3-dev musl-dev libffi-dev && \
+    apk add postgresql-dev && \
+    apk add --no-cache --virtual .build-deps-testing \
+    --repository http://dl-cdn.alpinelinux.org/alpine/edge/testing \
+    gdal-dev \
+    geos-dev \
+    proj4-dev
+
+RUN mkdir /config
+COPY /config/requirements.txt /config/
+RUN pip install -r /config/requirements.txt
+RUN mkdir /src
+WORKDIR /src
+EXPOSE 80
+CMD ["/bin/ash", "./init.sh", "gunicorn chron.wsgi -b 0.0.0.0:80"]

Makefile

@@ -0,0 +1,58 @@
+# import config
+# You can change the default config with `make cnf="config_special.env" [command]`
+cnf ?= django.env
+include $(cnf)
+
+# Documentation
+.PHONY: help
+
+help: ## Displays this message
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
+
+.DEFAULT_GOAL := help
+
+# Docker tasks
+
+build: ## Builds and tags containers
+	docker-compose build
+
+run: ## Builds, starts, and runs containers
+	docker-compose up --build -d
+
+stop: ## Stops running containers
+	docker-compose stop
+
+clean: ## Stop and remove containers, networks, volmes, and images
+	docker-compose down
+
+# Debug tools
+run_debug: ## Builds, starts, and runs containers, running the built-in Django web server
+	docker-compose run --service-ports web sh init.sh python manage.py runserver 0.0.0.0:81
+
+exec_debug: ## Runs built-in Django web server
+	docker-compose exec web python manage.py runserver 0.0.0.0:81
+
+# Misc
+test: ## Builds, starts, and runs containers, running the django tests
+	docker-compose run --service-ports web sh init.sh python manage.py test
+
+exec_test: ## Executes django tests in a running container
+	docker-compose exec web python manage.py test
+
+exec_testk: ## Executes django tests in a running container, keeping the database schema from the previous test run
+	docker-compose exec web python manage.py test -k
+
+lint: ## Lints python files to pass CI
+	docker-compose exec web black . --exclude /migrations/
+
+bash: ## SSH into the docker container
+	docker-compose exec web sh
+
+shell: ## Open the django shell (https://django-extensions.readthedocs.io/en/latest/shell_plus.html)
+	docker-compose exec web python manage.py shell_plus
+
+dbshell: ## Open postgres
+	docker-compose exec -u postgres db psql
+
+admin: ## Creates a super user in the running `web` container based on the values supplied in the configuration file [NOT WORKING ATM]
+	docker-compose exec web ./manage.py shell -c "from django.contrib.auth.models import User; User.objects.create_superuser('$(ADMIN_USER)', '$(ADMIN_EMAIL)', '$(ADMIN_PASS)')"

README.md

@@ -0,0 +1,19 @@
+# Chron Backend
+
+## Getting Started
+
+```bash
+# Clone the repo
+git clone https://github.com/chronoscio/backend
+cd backend
+
+# Create env files, remember to update accordingly
+cp django.env.sample django.env
+cp postgres.env.sample postgres.env
+
+# Build and start the docker containers
+make run
+
+# Navigate to http://localhost/
+# 502 error means postgres is starting, try again in a few seconds
+```

config/nginx/django.conf

@@ -0,0 +1,18 @@
+upstream web {
+   ip_hash;
+   server web:80;
+}
+
+# portal
+server {
+  location / {
+    proxy_pass http://web/;
+  }
+  listen 80;
+  server_name localhost;
+
+  location /static {
+    autoindex on;
+    alias /src/static/;
+  }
+}

config/requirements.txt

@@ -0,0 +1,8 @@
+black==18.9b0
+django-extensions==2.1.3
+Django==2.1.2
+gunicorn==19.7.0
+ipython==7.0.1
+psycopg2==2.7.4
+pylint-django==0.11.1
+pylint==1.8.4

django.env

@@ -0,0 +1,5 @@
+SECRET=dummy
+
+ADMIN_USER=admin
+ADMIN_EMAIL=[email protected]
+ADMIN_PASS=p@55w0rd1

django.env.sample

@@ -0,0 +1,5 @@
+SECRET=dummy
+
+ADMIN_USER=admin
+[email protected]
+ADMIN_PASS=p@55w0rd1

docker-compose.yml

@@ -0,0 +1,34 @@
+version: '3'
+services:
+  db:
+    image: mdillon/postgis:10-alpine
+    container_name: postgres01
+    ports:
+      - '5432'
+    env_file:
+      - postgres.env
+  nginx:
+    image: nginx:1.13-alpine
+    container_name: nginx01
+    ports:
+      - '80:80'
+    volumes:
+      - ./project:/src
+      - ./config/nginx:/etc/nginx/conf.d
+    depends_on:
+      - web
+  web:
+    build: .
+    container_name: django01
+    depends_on:
+      - db
+    volumes:
+      - ./project:/src
+    expose:
+      - '80'
+    ports:
+      - '3500:3500'
+      - '8006:81'
+    env_file:
+      - django.env
+    restart: always

postgres.env

@@ -0,0 +1,3 @@
+POSTGRES_USER=postgres
+POSTGRES_DB=postgres
+POSTGRES_PASSWORD=postgres

postgres.env.sample

@@ -0,0 +1,3 @@
+POSTGRES_USER=postgres
+POSTGRES_DB=postgres
+POSTGRES_PASSWORD=postgres