https://github.com/pybites-open-source/affirmations-api

Using FastAPI + SQLModel to keep track of affirmations
https://github.com/pybites-open-source/affirmations-api

fastapi hacktoberfest pybites python sqlmodel

Last synced: 16 days ago
JSON representation

Using FastAPI + SQLModel to keep track of affirmations

• Host: GitHub
• URL: https://github.com/pybites-open-source/affirmations-api
• Owner: PyBites-Open-Source
• Created: 2021-09-05T18:02:14.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-04T15:31:57.000Z (about 1 month ago)
• Last Synced: 2024-10-09T17:33:51.342Z (28 days ago)
• Topics: fastapi, hacktoberfest, pybites, python, sqlmodel
• Language: Python
• Homepage:
• Size: 59.6 KB
• Stars: 8
• Watchers: 2
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Affirmations API

This API is to keep track of affirmations.

To get a virtual environment running and install the dependencies:

```

make setup

```

You might have to manually enable your virtual environment after this:

```

source venv/bin/activate

```

Next set your `DATABASE_URL` environment variable:

```

cp .env-template .env

# update DATABASE_URL in .env

```

To run the flake8 / mypy / tests:

```

make lint

make typing

make test

```

Or run them all in one:

```

make ci

```

To run `black` upon commit (recommended) install `pre-commit`:

```

make precommit

```

To run the `uvicorn` webserver:

```

make run

```

Then navigate to [http://localhost:8000/docs](http://localhost:8000/docs) - enjoy!