https://github.com/kayprogrammer/bidout-auction-v3
A Simple Bidding API Built With Litestar Framework And SQLAlchemy
https://github.com/kayprogrammer/bidout-auction-v3
litestar postgresql pydantic sqlalchemy
Last synced: about 1 month ago
JSON representation
A Simple Bidding API Built With Litestar Framework And SQLAlchemy
- Host: GitHub
- URL: https://github.com/kayprogrammer/bidout-auction-v3
- Owner: kayprogrammer
- Created: 2023-06-02T05:19:48.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-23T03:07:01.000Z (over 1 year ago)
- Last Synced: 2025-01-29T15:22:03.950Z (3 months ago)
- Topics: litestar, postgresql, pydantic, sqlalchemy
- Language: Python
- Homepage: https://bidout-litestar-api.vercel.app
- Size: 788 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BidOut Auction V3
#### LITESTAR DOCS: [Documentation](https://docs.litestar.dev/)
#### PG ADMIN: [Documentation](https://pgadmin.org)
#### Swagger: [Documentation](https://swagger.io/docs/)
## How to run locally
* Download this repo or run:
```bash
$ git clone [email protected]:kayprogrammer/bidout-auction-v3.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
$ alembic upgrade heads
```
```bash
$ uvicorn app.main:app --debug --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-fastapi.vercel.app/)
#### POSTMAN API Url: [BidOut Docs](https://bit.ly/bidout-api)
