README.md

BidOut Auction V3

LITESTAR DOCS: Documentation

PG ADMIN: Documentation

Swagger: Documentation

How to run locally

• Download this repo or run:

    $ git clone [email protected]:kayprogrammer/bidout-auction-v3.git

In the root directory:

• Install all dependencies

    $ pip install -r requirements.txt

• Create an .env file and copy the contents from the .env.example to the file and set the respective values. A postgres database can be created with PG ADMIN or psql

• Run Locally

    $ alembic upgrade heads 

    $ uvicorn app.main:app --debug --reload

• Run With Docker

    $ docker-compose up --build -d --remove-orphans

OR

    $ make build

• Test Coverage

    $ pytest --disable-warnings -vv

OR

    $ make test

Docs

SWAGGER API Url: BidOut Docs

POSTMAN API Url: BidOut Docs