README.md

YAFT - Yet Another FastAPI Template

Setup

Prerequisites

• https://github.com/casey/just
• https://python-poetry.org/
• https://www.npmjs.com/

Setup

poetry install
npm i

Env variables:

.env

AUTH0_DOMAIN=...
AUTH0_CLIENT_ID=...
AUTH0_CLIENT_SECRET=...
DATABASE_URL=...
DATABASE_URL_PROD=...
ENV=dev

Database Management

Whenever you change the schema, run the following commands to migrate the databse. Be sure your env variables are set.

just revision $env # where $env is dev or prod
# THIS
just upgrade $env
# OR
just upgrade-all

Launching the server and css env (needs two terminals)

just css
just post && just run

Going to Production

just up

References

• Server built with: https://fastapi.tiangolo.com/
• Databse management: https://alembic.sqlalchemy.org/en/latest/
• Hosting: https://railway.app/
• Authentication: https://auth0.com/ - https://auth0.com/docs/quickstart/webapp/python/interactive
• Templating: https://jinja.palletsprojects.com/en/3.1.x/
• Styling: https://tailwindcss.com/
• Package management: https://python-poetry.org/

Misc Commands

poetry run alembic init alembic
poetry run python -m unittest

Educational Resources

For providing CLI arguments to alembic: https://gist.github.com/twolfson/4bc5813b022178bd7034