Requirements

This project makes the following assumptions.

auth0

algorithms=["RS256"]

Setup

Environment Variables #FIXME

Example Application

This is based on: coreycothrum/fastapi_template.

Do all setup from previous section.

SSL Certificates

Follow these instructions to setup HTTPS certificates.

This is needed even for development. Auth0 needs a domain to redirect to. HTTPS should be a requirement here.

Contributing

Rules for working in/with this repo.

Use Conventional Commits

Git commits should adhere to the conventional commits spec.

Use pre-commit

Keep the repo clean, use pre-commit.

1. Install pre-commit.

2. Apply pre-commit config to local git hook script(s):

    pre-commit install
    pre-commit install --hook-type commit-msg
   

3. (optional, as needed) Update pre-commit config to latest:

    pre-commit autoupdate
   

4. (optional, as needed) Manually run pre-commit check(s):

    pre-commit run --all-files