Skip to content

A generic API for an e-commerce backend service, developed with Python FastAPI and PostgreSQL.

Notifications You must be signed in to change notification settings

semroig/ecommerce-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ecommerce-api

A generic API for an ecommerce backend service. Developed with Python FastAPI and PostgreSQL.

Database entities architecture

lucidchart diagram screen

How to run locally

This project works with a Python virtual environment. For that sake, the first time you'll need to create that environment locally, activate it and install all the dependencies:

python -m venv env
source env/bin/activate
pip install -r requirements.txt

The next times, you'll just need to activate it 😉 and run the app:

source env/bin/activate
python3 -m uvicorn app.main:app --reload

When you are done working on the project, you can deactivate the virtual environment with just running:

deactivate

Setting up PostgreSQL instance url variable

In order for the app to work, you need to set up the PostgreSQL instance url variable. It is an environment variable that sqlalchemy uses to connect and run the engine. Go to env/bin/activate and add this line to the file (setting your_database_url with the correct url):

export SQLALCHEMY_DATABASE_URL='your_database_url'

Pendiente de armar

Cosas para agregar en el readme: file tree organization types declared using pydantic request and response schemas on documentation redoc docs

Cosas para agregar al proyecto: EmailStr con email_validator Deploy app -> donde?? Deploy db con postgres en Render Testing Docker container eslint + prettier config para formateo

About

A generic API for an e-commerce backend service, developed with Python FastAPI and PostgreSQL.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published