Merge pull request #2 from alephmelo/apply-cookiecutter-format

Apply cookiecutter format

Author: alephmelo

README.md

@@ -19,3 +19,42 @@ The `envs` folder contains the files so you can use different settings depending
 - `HOST`=`0.0.0.0`
 - `APP_MODULE`=`<module>.<module>:<fastapi-app-name>`
 - `WORKERS_PER_CORE`=`1`
+
+## Usage
+### Download
+```
+$ cookiecutter https://github.com/alephmelo/fast-api-docker-template.git
+```
+
+### Build
+This will build both `dev` and `prod` images.
+```bash
+$ make build
+```
+
+### Up
+```bash
+$ make up-dev
+[...]
+dev_1   | INFO:     Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
+dev_1   | INFO:     Started reloader process [1] using statreload
+dev_1   | INFO:     Started server process [7]
+dev_1   | INFO:     Waiting for application startup.
+dev_1   | INFO:     Application startup complete.
+```
+
+## Deployment
+Just push your built image to whatever cloud provider or manually start the service. It's tagged locally as `<app_namme>/<app_name>:latest-prod`.
+
+Example:
+```
+$ make up-prod
+docker run -p 80:80 <app_namme>/<app_name>:latest-prod
+INFO:     Started server process [1]
+INFO:     Waiting for application startup.
+INFO:     Application startup complete.
+INFO:     Uvicorn running on http://0.0.0.0:80 (Press CTRL+C to quit)
+```
+
+## Release History
+- 0.1.0 - Initial version.

cookiecutter.json

@@ -0,0 +1,5 @@
+{
+    "app_name": "helloworld",
+    "main_file_name": "app",
+    "python_version": "3.8"
+}

docker-compose.yml

@@ -1,6 +1,6 @@
-FROM python:3.8 as base
+FROM python:{{cookiecutter.python_version}} as base
 
-WORKDIR /home/workingtitle
+WORKDIR /home/{{cookiecutter.app_name}}
 
 COPY requirements.txt requirements.txt
 
@@ -20,7 +20,7 @@ COPY . .
 
 ARG PORT=80
 ARG HOST=0.0.0.0
-ARG APP_MODULE=workingtitle.workingtitle:app
+ARG APP_MODULE={{cookiecutter.app_name}}.{{cookiecutter.main_file_name}}:app
 ARG WORKERS_PER_CORE=1
 
 ENV MODE=production

.editorconfig {{cookiecutter.app_name}}/.editorconfig

@@ -13,7 +13,7 @@ up-dev:
 	docker-compose up dev
 
 up-prod:
-	docker run -p 80:80 workingtitle/workingtitle:latest-prod
+	docker run -p 80:80 {{cookiecutter.app_name}}/{{cookiecutter.app_name}}:latest-prod
 
 bash:
 	docker-compose run --entrypoint=bash dev

.gitignore {{cookiecutter.app_name}}/.gitignore

@@ -0,0 +1,26 @@
+version: "3.8"
+
+services: 
+  dev:
+    image: {{cookiecutter.app_name}}/{{cookiecutter.app_name}}:latest-dev
+    working_dir: /home/{{cookiecutter.app_name}}
+    entrypoint: uvicorn {{cookiecutter.app_name}}.{{cookiecutter.main_file_name}}:app --reload --host 0.0.0.0
+    build: 
+      target: development
+      context: .
+      dockerfile: Dockerfile
+    ports: 
+      - 8000:8000
+    volumes:
+      - .:/home/{{cookiecutter.app_name}}
+    
+    environment: 
+      - MODE=development
+  
+  prod:
+    image: {{cookiecutter.app_name}}/{{cookiecutter.app_name}}:latest-prod
+    working_dir: /production/{{cookiecutter.app_name}}
+    build: 
+      target: production
+      context: .
+      dockerfile: Dockerfile

Dockerfile {{cookiecutter.app_name}}/Dockerfile

@@ -1,10 +1,11 @@
 from os import getenv
 from pydantic import BaseSettings
 
+
 class Settings(BaseSettings):
-    app_name: str = "Awesome API"
+    app_name: str = "{{cookiecutter.app_name}}"
     mode: str
     dbpath: str
 
     class Config:
-        env_file = f"workingtitle/envs/{getenv('MODE')}.env"
+        env_file = f"{{cookiecutter.app_name}}/envs/{getenv('MODE')}.env"

LICENSE {{cookiecutter.app_name}}/LICENSE

@@ -1,5 +1,5 @@
 from fastapi import FastAPI
-from workingtitle.utils.settings import Settings
+from {{cookiecutter.app_name}}.utils.settings import Settings
 
 
 app = FastAPI()