Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 896 Bytes

README.md

File metadata and controls

37 lines (25 loc) · 896 Bytes
Raw

API for the React Blog App by Chathura Yapa

API Domains

  • Blog domain

    • Create
    • Delete
    • Read

  • Comment domain

    • Create
    • Delete
    • Read

  • Like domain

    • Create
    • Delete
    • Read

  • Database migration

    • Create migration shell script
    • Create migration SQLs

  • Docker setup

    • Basic API deployment
    • Database migration before API dpeloyment

  • MakeFile setup

How to run the API in local machine

  1. Clone this repo from GitHub and from root directory run pip install -r requirements.txt to install the dependancies.

    Then run uvicorn main:app --reload to host the API in local machine. The documentation is available on http://127.0.0.1:8000/docs

  2. Or if you have Docker, run docker-compose up