Skip to content

A simple REST API made using FastAPI and SQLAlchemy for the 2CC Session on FastAPI by DSC VIT Vellore. It has now been turned into a template and is a great place for beginners to get started!

License

Notifications You must be signed in to change notification settings

mdhishaamakhtar/fastapi-sqlalchemy-postgres-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FAST API

FastAPI Template

A template for the beginners


About

This is a beginner's template for getting started with FastAPI. It uses SQLAlchemy as the ORM.

Contributions are welcome.

Features

  • Database Connection Using SQLAlchemy
  • FastAPI Server
  • Unit Testing with PyTest
  • Basic CRUD for Posts

Dependencies

  • Python 3.7+
  • Pip
  • Other listed in requirements.txt

Running

  • Clone the repo using
git clone https://github.com/mdhishaamakhtar/fastapi-sqlalchemy-postgres-template
  • Create a Virtual Environment using
sudo pip install virtualenv
virtualenv env
  • Activate the virtualenv
env\Scripts\activate # for windows
source env/bin/activate # for linux and mac
  • Install dependencies
pip install -r requirements.txt
  • Setting up environment variables
Key Value
DATABASE_URL postgresql://user:password@host:port/db
  • To run the project
uvicorn main:app

Contributors

Md Hishaam Akhtar

Md Hishaam Akhtar

GitHub LinkedIn

About

A simple REST API made using FastAPI and SQLAlchemy for the 2CC Session on FastAPI by DSC VIT Vellore. It has now been turned into a template and is a great place for beginners to get started!

Topics

Resources

License

Stars

Watchers

Forks

Languages