Giter VIP home page Giter VIP logo

fastapi-starter-project's Introduction

FastAPI Starter Project

Project includes:

  • fastapi
  • sqlmodel
  • alembic

Models

Check db/models and migrations, there is one example.

Using docker

Setup env variables in app/core/.env.

Install and run

docker-compose up -d web

# you can track logs with:
docker-compose logs -f --tail=100 web

Go to: http://localhost:8000/api/docs/

Migrations

Create migrations

docker-compose exec web alembic revision --autogenerate -m "Example model"

Apply migrations

docker-compose exec web alembic alembic upgrade head

Without docker

Install

cd app/
pip install -r requirements/development.txt

Setup env variables in app/core/.env.

Run

cd app/
python app/server.py

Go to: http://localhost:8000/api/docs/

Migrations

Create migrations

alembic revision --autogenerate -m "Example model"

Apply migrations

alembic upgrade head

Environment Variables

To run this project, you will need to add the following environment variables to your app/core/.env file

BASE_URL - default: http://localhost:8000

RELOAD - default: false

DB_HOST - default: localhost

DB_PORT - default: 5432

DB_USER - default: postgres

DB_PASS - default: postgres

DB_BASE - default: db

DB_ECHO - default: false

fastapi-starter-project's People

Contributors

mirzadelic avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.