Pet Agenda (backend)

Description

API for keeping track of a pet parent's pets and their a pet's needs.
Used for Pet Agenda (frontend).

FastAPI framework using ORM SQLAlchemy with a PostgreSQL server. Deployed to Heroku.

Dependencies

These are some important dependencies, but all are found in requirements.txt
Python version important if using Heroku for deployment.

In requirements.txt,

black==22.1.0
email-validator==1.1.3
fastapi==0.73.0
passlib==1.7.4
psycopg2-binary==2.8.6
pydantic==1.9.0
python==3.8.9
python-dotenv==0.19.2
python-jose==3.3.0
SQLAlchemy==1.3.24
uvicorn==0.17.4

Instructions

1. Clone repository
2. cd into project folder
3. Create virtual environment in project folder

python -m venv venv

4. Create .env file in root directory and add the below lines

POSTGRES_USER=USER
POSTGRES_PASSWORD=PASSWORD
POSTGRES_SERVER=localhost
POSTGRES_PORT=5432
POSTGRES_DB=DATABASENAME

5. Install dependencies

pip install -r requirements.txt

TODOs

1. Clean up user authentication code
2. Edit pet diet endpoints to reflect keeping track of a pet's diet
3. Include pet exercise model and schema

Useful Tutorials & Resources

• rithmic -Youtube
• Bitfumes -Youtube

SQLAlchemy Docs

FastAPI SQL Relational db tutorial

FastAPI Bigger Application Tutorial