Giter Club home page Giter Club logo

novel-app-be's Introduction

novel-app-backend

novel-app-backend

How to run everything?

docker-compose -f deployment/docker-compose.yml up --build

Now, you have a local Postgresql database and a FastApi APP running.

Navigate to localhost:8080/docs, you will have a Open-API page ready. open api page

The template creates two example entities, User and Blog, to help you start your own development,

  • users: you can create a user or fetch all users.
  • Click the Authorize button to login with the user-name and password you just created.
  • blogs: create a blog for the current user or fetch blogs created by the active user.

Now, you have everything ready and running,

If you prefer to just run the API locally, you can follow the below steps.

Run API locally

  • Install Poetry
pipx install poetry

or

pip install poetry
  • Spin up a virtual environment
poetry shell
  • Install all dependencies
poetry install
  • Start a local database
docker-compose -f deploy/docker-compose.yml up --build db
  • Run database migrations
alembic upgrade head
  • Start your FastApi APP
uvicorn src.main:app --host 0.0.0.0 --port 8080

novel-app-be's People

Contributors

namle-mf avatar

Watchers

Lê Hoàng Nam 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.