https://github.com/kayprogrammer/bidout-auction-v4
A simple bidding API built with Django rest framework
https://github.com/kayprogrammer/bidout-auction-v4
bidding django django-rest-framework pgadmin4 postgresql
Last synced: 2 months ago
JSON representation
A simple bidding API built with Django rest framework
- Host: GitHub
- URL: https://github.com/kayprogrammer/bidout-auction-v4
- Owner: kayprogrammer
- Created: 2023-06-24T15:50:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-25T00:29:39.000Z (over 1 year ago)
- Last Synced: 2024-04-16T02:22:26.762Z (over 1 year ago)
- Topics: bidding, django, django-rest-framework, pgadmin4, postgresql
- Language: Python
- Homepage: https://bidout-drf-api.vercel.app
- Size: 866 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BidOut Auction V4
#### DJANGO DOCS: [Documentation](https://docs.djangoproject.com/en/4.2/)
#### DJANGO REST FRAMEWORK DOCS: [Documentation](https://www.django-rest-framework.org/)
#### 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-v4.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_v4.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-drf-api.vercel.app/)
#### POSTMAN API Url: [BidOut Docs](https://bit.ly/bidout-api)
## ADMIN PAGE
