Git Product home page Git Product logo

todo-app's Introduction

Microsite Backend FastAPI Project

How to setup project?

Clone the project from Gitlab

git clone this project or download the project to your computer locally

Start the server (Build & Up the docker images)

docker-compose up -d --build

Run a migration

docker-compose exec backend alembic upgrade head

View the API Documentation (This will ensure the server is running)

  1. Open your web browser of choice
  2. In the URL enter: http://0.0.0.0:3000/docs

View the FRONTEND Application (This will ensure the server is running)

  1. Open your web browser of choice
  2. In the URL enter: http://0.0.0.0:3001

Development Commands

Check the status of the docker containers

docker-compose ps -a

Check logs of fastapi server

docker-compose logs -f --tail 10 backend

Stop the server

docker-compose stop

Down the server

docker-compose down

Alembic DB Migrations

Alembic is used for generating migrations for the database with SQL Alchemy.

Create an autogenerate migration

docker-compose -f docker-compose.yml run backend alembic revision --autogenerate -m [commit message]

Running a Migration

docker-compose -f docker-compose.yml run backend alembic upgrade head

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.