https://github.com/kayprogrammer/bidout-auction-v7
A simple bidding API built with Go Fiber
https://github.com/kayprogrammer/bidout-auction-v7
fiber golang gorm pgadmin4 postgresql
Last synced: 4 months ago
JSON representation
A simple bidding API built with Go Fiber
- Host: GitHub
- URL: https://github.com/kayprogrammer/bidout-auction-v7
- Owner: kayprogrammer
- Created: 2023-07-15T17:48:35.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-02T08:59:08.000Z (almost 2 years ago)
- Last Synced: 2025-07-26T01:26:12.669Z (6 months ago)
- Topics: fiber, golang, gorm, pgadmin4, postgresql
- Language: Go
- Homepage:
- Size: 422 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BIDOUT AUCTION V7
A simple bidding API built with Fiber
#### FIBER DOCS: [Documentation](https://docs.gofiber.io/)
#### GORM DOCS: [Documentation](https://gorm.io/)
#### 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-v7.git
```
#### In the root directory:
- Install all dependencies
```bash
$ go install github.com/cosmtrek/air@latest
$ go mod download
```
- 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
$ air
```
- Run With Docker
```bash
$ docker-compose up --build -d --remove-orphans
```
OR
```bash
$ make build
```
- Test Coverage
```bash
$ go test ./tests -v -count=1
```
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)
