Skip to content

kayprogrammer/bidout-auction-v4

Repository files navigation

BidOut Auction V4

alt text

DJANGO DOCS: Documentation

DJANGO REST FRAMEWORK DOCS: Documentation

PG ADMIN: Documentation

Swagger: Documentation

How to run locally

  • Download this repo or run:
    $ git clone git@github.com:kayprogrammer/bidout-auction-v4.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

    $ python manage.py migrate 
    $ uvicorn bidout_auction_v4.asgi:application --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

alt text

alt text

alt text

alt text

alt text

ADMIN PAGE

alt text

Releases

No releases published

Packages

No packages published

Languages