docs: update README; chore: improve folder structure; feat: add make commands

Author: nickatnight

.env_example

@@ -1,6 +1,5 @@
 # app
-ENCRYPT_KEY=
-SECRET_KEY=
+SECRET_KEY=test-key
 ENV=dev
 PROJECT_NAME=fastapi_backend_base
 VERSION=v1
@@ -24,5 +23,5 @@ REDIS_HOST=redis
 REDIS_PORT=6379
 
 # Misc
-CLIENT_ID=
-CLIENT_SECRET=
+CLIENT_ID=client-id
+CLIENT_SECRET=client-secret

Makefile

@@ -0,0 +1,48 @@
+all:
+
+# docker
+up:
+	@echo "bringing up project...."
+	docker compose up
+
+down:
+	@echo "bringing down project...."
+	docker compose down
+
+# alembic
+alembic-scaffold:
+	@echo "scaffolding migrations folder..."
+	docker compose exec backend alembic init -t async migrations
+
+alembic-init:
+	@echo "initializing first migration...."
+	docker compose exec backend alembic revision --autogenerate -m "init"
+
+alembic-make-migrations:
+	@echo "creating migration file...."
+	docker compose exec backend alembic revision --autogenerate -m "add year"
+
+alembic-migrate:
+	@echo "applying migration...."
+	docker compose exec backend alembic upgrade head
+
+# lint
+test:
+	@echo "running pytest...."
+	docker compose exec backend pytest --cov-report xml --cov=src tests/
+
+flake8:
+	@echo "running flake8...."
+	docker compose exec backend flake8
+
+black:
+	@echo "running black...."
+	docker compose exec backend black .
+
+# misc
+check: BREW-exists
+BREW-exists: ; @which brew > /dev/null
+
+hooks: check
+	@echo "installing pre-commit hooks...."
+	pre-commit install

README.md

@@ -40,11 +40,42 @@ Small base project I use to build and deploy fastapi backends..batteries include
 2. `cd fastapi-backend-base`
 3. `mv .env_example .env`
 4. `docker compose up --build`
-5. visit `http://localhost:8000` for uvicorn server, or `http://localhost` for nginx proxy
+5. visit `http://localhost:8666/v1/openapi.json` for uvicorn server, or `http://localhost` for nginx proxy
 
-## Deploy
-A common scenario is to use an orchestration tool, such as docker swarm, to deploy your containers to the cloud (DigitalOcean)
+## Nginx
+```yml
+volumes:
+  proxydata-vol:
+...
+proxy:
+    image: your-registry/proxy # OR
+    build:
+      context: ./proxy
+      dockerfile: ./Dockerfile
+    environment:
+      - UPSTREAMS=/:backend:8000
+      - NGINX_SERVER_NAME=yourservername.com
+      - ENABLE_SSL=true
+      - HTTPS_REDIRECT=true
+      - [email protected]
+      - DOMAIN_LIST=yourservername.com
+    ports:
+      - '0.0.0.0:80:80'
+      - '0.0.0.0:443:443'
+    volumes:
+      - proxydata-vol:/etc/letsencrypt
+```
+
+Some of the envrionment variables available:
+- `UPSTREAMS=/:backend:8000` a comma separated list of \<path\>:\<upstream\>:\<port\>.  Each of those of those elements creates a location block with proxy_pass in it.
+- `HTTPS_REDIRECT=true` enabled a standard, ELB compliant https redirect.
+- `ENABLE_SSL=true` to enable redirects to https from http
+- `NGINX_SERVER_NAME` name of the server and used as path name to store ssl fullchain and privkey
+- `[email protected]` the email to register with Certbot.
+- `DOMAIN_LIST` domain(s) you are requesting a certificate for.
 
-## Configuration
+When SSL is enabled, server will install Cerbot in standalone mode and add a new daily periodic script to `/etc/periodic/daily/` to run a cronjob in the background. This allows you to automate cert renewing (every 3 months). See [docker-entrypoint](proxy/docker-entrypoint.sh) for details.
 
-## Development
+
+## Deploy
+A common scenario is to use an orchestration tool, such as docker swarm, to deploy your containers to the cloud (DigitalOcean).

backend/.flake8

@@ -1,4 +1,4 @@
 [flake8]
 max-line-length = 100
-exclude = __init__.py,__pycache__,git
+exclude = __init__.py,__pycache__,git,migrations/
 ignore = F403,F405,W605,W503,E203,E231

backend/alembic.ini

@@ -2,7 +2,7 @@
 
 [alembic]
 # path to migration scripts
-script_location = migrations
+script_location = src/migrations
 
 # template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
 # Uncomment the line below if you want the files to be prepended with date and time

backend/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "fastapi-backend-base"
-version = "2.4.0"
+version = "3.0.0"
 description = "Base project for building fastapi backends"
 authors = ["nickatnight <[email protected]>"]
 
@@ -32,7 +32,19 @@ sections = 'FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER'
 [tool.black]
 line-length = 100
 include = '\.pyi?$'
-exclude = '(\.git|\.hg|\.mypy_cache|\.tox|\.venv|_build)'
+extend-exclude = '''
+(
+    | \.git          # root of the project
+    | \.hg
+    | \.mypy_cache
+    | \.tox
+    | \.venv
+    | _build
+    | buck-out
+    | build
+    | dist
+)
+'''
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

backend/migrations/README renamed to backend/src/migrations/README

@@ -1,8 +1,8 @@
 """init
 
-Revision ID: d7effbf2730a
+Revision ID: 3577cec8a2bb
 Revises:
-Create Date: 2022-09-03 07:30:33.398069
+Create Date: 2022-10-05 02:04:44.047062
 
 """
 import sqlalchemy as sa
@@ -11,7 +11,7 @@
 
 
 # revision identifiers, used by Alembic.
-revision = "d7effbf2730a"
+revision = "3577cec8a2bb"
 down_revision = None
 branch_labels = None
 depends_on = None