https://github.com/kayprogrammer/bidout-auction-v5
A simple bidding api built with django ninja
https://github.com/kayprogrammer/bidout-auction-v5
Last synced: 9 months ago
JSON representation
A simple bidding api built with django ninja
- Host: GitHub
- URL: https://github.com/kayprogrammer/bidout-auction-v5
- Owner: kayprogrammer
- Created: 2023-07-02T21:36:59.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-23T03:20:12.000Z (over 2 years ago)
- Last Synced: 2024-04-16T02:22:26.443Z (about 2 years ago)
- Language: Python
- Homepage: https://bidout-dnrf-api.vercel.app
- Size: 897 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BidOut Auction V5
#### DJANGO DOCS: [Documentation](https://docs.djangoproject.com/en/4.2/)
#### DJANGO NINJA DOCS: [Documentation](https://django-ninja.rest-framework.com/)
#### PG ADMIN: [Documentation](https://pgadmin.org)
#### Swagger: [Documentation](https://swagger.io/docs/)
## How to run locally
* Download this repo or run:
```bash
$ git clone git@github.com:kayprogrammer/bidout-auction-v5.git
```
#### In the root directory:
- Install all dependencies
```bash
$ 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
```bash
$ python manage.py migrate
```
```bash
$ uvicorn bidout_auction_v5.asgi:application --reload
```
- Run With Docker
```bash
$ docker-compose up --build -d --remove-orphans
```
OR
```bash
$ make build
```
- Test Coverage
```bash
$ pytest --disable-warnings -vv
```
OR
```bash
$ make test
```
## Docs
#### SWAGGER API Url: [BidOut Docs](https://bidout-dnrf-api.vercel.app/)
#### POSTMAN API Url: [BidOut Docs](https://bit.ly/bidout-api)
## ADMIN PAGE
