Skip to content

This project is created to assist in learning about FastAPI. It is a simple API example, for clothing list management.

Notifications You must be signed in to change notification settings

eduqz/clothes-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Clothes API

Introduction

This project is created to assist in learning about FastAPI. It is a simple API example, for clothing list management.

Technologies

This is a web application writted in Python using FastAPI as framework and SQLAlchemy as ORM. In my tests, I also used a PostgreSQL database.

How to run

Setup the enviroment (when running for the first time)

  1. Use virtualenv venv -p python3 to create a python virtual environment to your project. Learn more about it here
  2. Use source venv /bin/activate to activate the virtual environment
  3. Use pip install -r requirements.txt to install all the required packages

Running the applicaiton

  1. Use uvicorn main:app --reload to run the application
  2. Open http://localhost:8000/docs to view the API documentation and test the methods.

About

This project is created to assist in learning about FastAPI. It is a simple API example, for clothing list management.

Topics

Resources

Stars

Watchers

Forks

Languages