updating readme

Author: seantbaier

.circleci/config.yml

@@ -1 +1,44 @@
-# Serverless FastApi
+# Simple Serverless FastApi Example
+
+A simple serverless [FastAPI](https://fastapi.tiangolo.com/) application using [Mangum](https://pypi.org/project/mangum/) to run on an AWS [Lambda](https://aws.amazon.com/lambda/).
+
+## Complete Walkthrough
+
+### [Simple Serverless FastAPI with AWS Lambda Complete Walkthrough](https://www.deadbearcode.com/simple-serverless-fastapi-with-aws-lambda/)
+
+## Installation
+
+### Setup Virtual Environment
+
+```shell
+virtualenv -p python3.7 env
+source ./env/bin/activate
+```
+
+### Install Dependencies
+
+```shell
+pip install -r requirements.txt
+```
+
+## Run the application
+
+```shell
+uvicorn app.main:app --host 0.0.0.0 --port 8080 --reload
+```
+
+## Deploy
+
+### Package Dependencies
+
+```shell
+cd env/lib/python3.7/site-packages
+zip -r9 /path/to/root/function.zip
+```
+
+### Package Lambda
+
+```shell
+cd /path/to/root
+zip -g function.zip lambda_function.py
+```

README.md

@@ -4,4 +4,4 @@
 
 @router.get("/")
 async def root():
-    return {"message": "Users!"}
+    return {"message": "Get Users!"}

app/api/api_v1/endpoints/users.py

@@ -1,16 +1,15 @@
 from fastapi import FastAPI
 
 from app.api.api_v1.api import router as api_router
-from app.core.config import settings
 from mangum import Mangum
 
 app = FastAPI()
 
 
 @app.get("/")
 async def root():
-    return {"message": f"Secret Key: {settings.SECRET_KEY}"}
+    return {"message`": "Hello World!"}
 
 
-app.include_router(api_router, prefix=settings.API_V1_STR)
-handler = Mangum(app)
+app.include_router(api_router, prefix="api/v1")
+handler = Mangum(app)

app/core/__init__.py

@@ -1,47 +0,0 @@
-aiofiles==0.5.0
-aniso8601==7.0.0
-async-exit-stack==1.0.1
-async-generator==1.10
-attrs==19.3.0
-certifi==2020.6.20
-chardet==3.0.4
-click==7.1.2
-dnspython==2.0.0
-email-validator==1.1.1
-fastapi==0.60.1
-graphene==2.1.8
-graphql-core==2.3.2
-graphql-relay==2.0.1
-h11==0.9.0
-httptools==0.1.1
-idna==2.10
-importlib-metadata==1.7.0
-iniconfig==1.0.1
-itsdangerous==1.1.0
-Jinja2==2.11.2
-mangum==0.9.2
-MarkupSafe==1.1.1
-more-itertools==8.4.0
-orjson==3.3.0
-packaging==20.4
-pluggy==0.13.1
-promise==2.3
-py==1.9.0
-pydantic==1.6.1
-pyparsing==2.4.7
-pytest==6.0.1
-python-dotenv==0.14.0
-python-multipart==0.0.5
-PyYAML==5.3.1
-requests==2.24.0
-Rx==1.6.1
-six==1.15.0
-starlette==0.13.6
-toml==0.10.1
-typing-extensions==3.7.4.2
-ujson==3.0.0
-urllib3==1.25.10
-uvicorn==0.11.6
-uvloop==0.14.0
-websockets==8.1
-zipp==3.1.0