Adding files for Running locally with Uvicorn, previously living in a Gist.

Author: carlosplanchon

.gitignore

@@ -135,3 +135,8 @@ cython_debug/
 .idea
 
 .vscode/
+
+# Config files:
+src/.env
+docker-compose.yml
+Dockerfile

Dockerfile

@@ -28,21 +28,17 @@ Use the template on GitHub, create your repo, then:
 git clone https://github.com/<you>/<your-app>
 cd <your-app>
 
-# NOTE (added by me):
-# Running locally with Uvicorn.
-# The .env and docker-compose.yml files were taken from this Gist:
-# https://gist.github.com/igorbenav/48ad745120c3f77817e094f3a609111a
-# I kept the local Dockerfile since it uses 'uv' instead of Poetry
-# (the Gist version relies on Poetry).
+# Running locally with Uvicorn:
 
-# TODO: Decide where to put the example file, since it is currently
-# being copied from the Gist.
+# Copy Dockerfile and Docker Compose files:
+cp scripts/local_with_uvicorn/Dockerfile Dockerfile
+cp scripts/local_with_uvicorn/docker-compose.yml docker-compose.yml
 
 # Copy and create your environment file
-cp src/.env.example src/.env
-# Fill in the minimal environment variables as described in the docs
+cp scripts/local_with_uvicorn/env src/.env
+# If you want, modify in the minimal environment variables as described in the docs.
 
-# Run everything using Docker
+# Run everything using Docker:
 docker compose up
 
 # Open the API documentation

README.md

@@ -0,0 +1,53 @@
+# ------------- app settings ------------- 
+APP_NAME="My Project"
+APP_DESCRIPTION="My Project Description"
+APP_VERSION="0.1"
+CONTACT_NAME="Me"
+CONTACT_EMAIL="[email protected]"
+LICENSE_NAME="MIT"
+
+# ------------- database ------------- 
+POSTGRES_USER="postgres"
+POSTGRES_PASSWORD=1234
+POSTGRES_SERVER="db"
+POSTGRES_PORT=5432
+POSTGRES_DB="postgres"
+POSTGRES_ASYNC_PREFIX="postgresql+asyncpg://"
+
+# ------------- crypt -------------
+SECRET_KEY=de2132a4a3a029d6a93a2aefcb519f0219990f92ca258a7c5ed938a444dbe1c8
+ALGORITHM=HS256
+ACCESS_TOKEN_EXPIRE_MINUTES=60
+
+# ------------- admin -------------
+ADMIN_NAME="admin"
+ADMIN_EMAIL="[email protected]"
+ADMIN_USERNAME="admin"
+ADMIN_PASSWORD="Str1ngst!"
+
+# ------------- redis cache -------------
+REDIS_CACHE_HOST="redis"
+REDIS_CACHE_PORT=6379
+
+# ------------- redis queue -------------
+REDIS_QUEUE_HOST="redis"
+REDIS_QUEUE_PORT=6379
+
+# ------------- redis rate limit -------------
+REDIS_RATE_LIMIT_HOST="redis"
+REDIS_RATE_LIMIT_PORT=6379
+
+# ------------- client side cache -------------
+CLIENT_CACHE_MAX_AGE=60
+
+# ------------- test -------------
+TEST_NAME="Tester User"
+TEST_EMAIL="[email protected]"
+TEST_USERNAME="testeruser"
+TEST_PASSWORD="Str1ng$t"
+
+# ------------- environment -------------
+ENVIRONMENT="local"
+
+# ------------- first tier -------------
+TIER_NAME="free"