add server

Author: qdriven

{{ cookiecutter.project_slug }}/docker-compose.ci.yml

@@ -0,0 +1,8 @@
+version: "3.9"
+
+services:
+  backend:
+    image: "{{ cookiecutter.project_slug }}-backend:latest"
+
+  frontend:
+    image: "{{ cookiecutter.project_slug }}-frontend:latest"

{{ cookiecutter.project_slug }}/docker-compose.override.yml

@@ -0,0 +1,19 @@
+# We specify volumes in override.yml, because volumes don't work well in a
+# docker-in-docker setup (the paths of parent host rarely match the nested containers)
+version: "3.9"
+
+services:
+  postgres:
+    ports:
+      - "5432:5432"
+    volumes:
+      - app-db-data:/var/lib/postgresql/data:cached
+
+  backend:
+    command: uvicorn --port {{ cookiecutter.backend_port }} --host 0.0.0.0 --reload main:app
+    volumes:
+      - ./backend:/app:delegated
+      - root-home:/root:delegated
+    depends_on:
+      postgres:
+        condition: service_healthy

{{ cookiecutter.project_slug }}/docker-compose.yml

@@ -0,0 +1,37 @@
+version: "3.9"
+
+services:
+  postgres:
+    image: postgres:12
+    restart: always
+    env_file:
+      - .env
+    healthcheck:
+      test: pg_isready -U postgres
+      interval: 3s
+      timeout: 2s
+      retries: 3
+
+  backend:
+    build:
+      context: backend
+    ports:
+      - "{{ cookiecutter.backend_port }}:{{ cookiecutter.backend_port }}"
+    env_file: .env
+    depends_on:
+      postgres:
+        condition: service_healthy
+
+  frontend:
+    build:
+      context: frontend
+    ports:
+      - "{{ cookiecutter.frontend_port }}:80"
+    volumes:
+      - ./frontend:/app:delegated
+    environment:
+      - NODE_ENV=production
+
+volumes:
+  app-db-data:
+  root-home:

{{ cookiecutter.project_slug }}/pyproject.toml

@@ -30,23 +30,37 @@ packages = [
 {% endif %}
 
 [tool.poetry.dependencies]
-python = "^{{ cookiecutter.minimal_python_version }}"
+python = "^{{ cookiecutter.minimal_python_version }},<4.0"
 {% if cookiecutter.create_example_template == 'cli' %}
 typer = "^0.7.0"
 tqdm="^4.64.1"
 {% endif %}
+{% if cookiecutter.create_example_template == 'server' %}
+fastapi = "^0.98.0"
+uvicorn = "^0.23.2"
+requests = "^2.31.0"
+alembic = "^1.11.3"
+psycopg2-binary = "^2.9.7"
+asyncpg = "^0.28.0"
+SQLAlchemy = "^2.0.20"
+gunicorn = "^21.2.0"
+{% endif %}
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
+black = "^23.10.1"
 pytest = "^7.1.2"
 allure-pytest = "^2.10.0"
 pre-commit = "^2.21.0"
-isort = {extras = ["colors"], version = "^5.11.4"}
 darglint = "^1.8.1"
 pytest-html = "^3.2.0"
 coverage = "^7.0.5"
 coverage-badge = "^1.1.0"
 black = "^22.12.0"
 pytest-cov = "^4.0.0"
+ipython = "^8.16.1"
+pytest-cov = "^4.1.0"
+httpx = "^0.24.1"
+pytest-asyncio = "^0.21.1"
 
 [tool.black]
 # https://github.com/psf/black
@@ -70,55 +84,17 @@ exclude = '''
 )/
 '''
 
-[tool.isort]
-# https://github.com/timothycrosley/isort/
-py_version = {{ cookiecutter.minimal_python_version.replace('.', '') }}
-line_length = {{ cookiecutter.line_length }}
-known_typing = ["typing", "types", "typing_extensions", "mypy", "mypy_extensions"]
-sections = ["FUTURE", "TYPING", "STDLIB", "THIRDPARTY", "FIRSTPARTY", "LOCALFOLDER"]
-include_trailing_comma = true
-profile = "black"
-multi_line_output = 3
-indent = 4
-color_output = true
-force_single_line = true
-combine_as_imports = true
-lines_between_types = 1
-lines_after_imports = 2
-src_paths = ["src", "tests"]
-extend_skip = ["setup.py"]
-
-[tool.mypy]
-# https://mypy.readthedocs.io/en/latest/config_file.html#using-a-pyproject-toml-file
-python_version = {{ cookiecutter.minimal_python_version }}
-pretty = true
-show_traceback = true
-color_output = true
-allow_redefinition = false
-check_untyped_defs = true
-disallow_any_generics = true
-disallow_incomplete_defs = true
-ignore_missing_imports = true
-implicit_reexport = false
-no_implicit_optional = true
-show_column_numbers = true
-show_error_codes = true
-show_error_context = true
-strict_equality = true
-strict_optional = true
-warn_no_return = true
-warn_redundant_casts = true
-warn_return_any = true
-warn_unreachable = true
-warn_unused_configs = true
-warn_unused_ignores = true
 
 
+[tool.cruft]
+skip = [".env"]
+
 [tool.pytest.ini_options]
 # https://docs.pytest.org/en/6.2.x/customize.html#pyproject-toml
 # Directories that are not visited by pytest collector:
 norecursedirs =["hooks", "*.egg", ".eggs", "dist", "build", "docs", ".tox", ".git", "__pycache__"]
 doctest_optionflags = ["NUMBER", "NORMALIZE_WHITESPACE", "IGNORE_EXCEPTION_DETAIL"]
+asyncio_mode = 'auto'
 
 # Extra options:
 addopts = [

{{ cookiecutter.project_slug }}/scripts/deploy-demo-project-to-fly.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+cookiecutter --no-input . -f project_slug="demo-project-fastapi-starter" project_name="Demo project FastAPI starter"
+
+cp scripts/fly.toml ./demo-project-fastapi-starter/
+
+cd demo-project-fastapi-starter/
+
+flyctl deploy --remote-only

{{ cookiecutter.project_slug }}/scripts/fly.toml

@@ -0,0 +1,43 @@
+# fly.toml file generated for demo-project-fastapi-starter on 2022-05-26T14:02:13+02:00
+
+app = "demo-project-fastapi-starter"
+
+kill_signal = "SIGINT"
+kill_timeout = 5
+processes = []
+
+[env]
+
+[experimental]
+  allowed_public_ports = []
+  auto_rollback = true
+
+[deploy]
+  release_command = "alembic upgrade head"
+
+[[services]]
+  http_checks = []
+  internal_port = 8000
+  processes = ["app"]
+  protocol = "tcp"
+  script_checks = []
+
+  [services.concurrency]
+    hard_limit = 25
+    soft_limit = 20
+    type = "connections"
+
+  [[services.ports]]
+    force_https = true
+    handlers = ["http"]
+    port = 80
+
+  [[services.ports]]
+    handlers = ["tls", "http"]
+    port = 443
+
+  [[services.tcp_checks]]
+    grace_period = "1s"
+    interval = "15s"
+    restart_limit = 0
+    timeout = "2s"

{{ cookiecutter.project_slug }}/scripts/test.sh

@@ -0,0 +1,59 @@
+#! /usr/bin/env bash
+
+set -eou pipefail
+
+# Stop containers from previous run, if any
+(cd ./test-project && docker-compose -f docker-compose.yml down --rmi local -v && cd ..) || true
+
+# Run this from the root of the project
+rm -rf ./test-project
+
+cookiecutter --no-input -f ./ project_slug="test-project" project_name="Test project"
+
+cd ./test-project/
+
+# Start docker containers
+docker-compose -f docker-compose.yml up -d --build
+
+
+# Run backend tests
+docker-compose exec -T postgres createdb -U postgres apptest
+
+docker-compose exec -T backend pytest -v --cov --cov-report term-missing
+
+# Run cypress tests
+docker-compose exec -T backend alembic upgrade head
+
+docker-compose exec -T backend alembic check
+
+docker build --target build -t frontend-build:latest frontend
+
+mv $(pwd)/frontend/src/generated /tmp/src-generated
+
+PACKAGE_LIST="xvfb libnss3 libatk1.0 libatk-bridge2.0 libgtk-3.0 libgbm1 libasound2 default-jre"
+# If GITHUB_REPOSITORY is not set, then we can just run it in docker
+# We need to have two paths here because Github CI works weirdly with bind mounts that we can use to run the tests locally in Docker
+if [ -z "${GITHUB_REPOSITORY-}" ]
+then
+    docker run \
+    -v $(pwd)/frontend/src/generated/:/app/src/generated \
+    -v $(pwd)/frontend/cypress:/app/cypress \
+    --network="host" \
+    frontend-build \
+    bash -xc "apt-get update -qq &&
+        apt-get install -qq $PACKAGE_LIST &&
+        yarn run-e2e-tests &&
+        yarn config set script-shell /bin/bash &&
+        yarn genapi"
+else
+    cd frontend
+    npm config set script-shell /bin/bash
+    sudo apt-get update -qq && sudo apt-get install -qq $PACKAGE_LIST
+    yarn install --frozen-lockfile
+    yarn run-e2e-tests
+    yarn genapi
+    cd ..
+fi
+#
+# This is to ensure that the generated API client is always in sync with FastAPI code
+diff -r /tmp/src-generated $(pwd)/frontend/src/generated || (echo "Generated files changed. Please make sure they are in sync" && exit 1)

{{ cookiecutter.project_slug }}/src/{{ cookiecutter.project_slug}}/Dockerfile

@@ -0,0 +1,29 @@
+ARG PYTHON_VER=3.11
+
+FROM python:${PYTHON_VER} AS base
+
+WORKDIR /app
+
+ENV PYTHONUNBUFFERED=1
+
+# Install Poetry
+RUN curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry python && \
+    cd /usr/local/bin && \
+    ln -s /opt/poetry/bin/poetry && \
+    poetry config virtualenvs.create false
+
+COPY ./pyproject.toml ./poetry.lock* /app/
+
+RUN poetry install --no-root
+
+COPY . /app
+
+FROM python:3.11-slim
+
+WORKDIR /app
+
+COPY --from=base /app /app
+COPY --from=base /usr/local/lib/python3.11/site-packages /usr/local/lib/python3.11/site-packages
+COPY --from=base /usr/local/bin /usr/local/bin
+
+CMD uvicorn --host 0.0.0.0 --port 8000 main:app