https://github.com/kayprogrammer/bidout-auction-v8
A simple bidding API built with NestJs and Prisma
https://github.com/kayprogrammer/bidout-auction-v8
nestjs pgadmin4 postgresql prisma
Last synced: 4 months ago
JSON representation
A simple bidding API built with NestJs and Prisma
- Host: GitHub
- URL: https://github.com/kayprogrammer/bidout-auction-v8
- Owner: kayprogrammer
- Created: 2023-10-27T17:06:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-23T03:25:47.000Z (over 1 year ago)
- Last Synced: 2025-01-29T15:22:16.241Z (6 months ago)
- Topics: nestjs, pgadmin4, postgresql, prisma
- Language: TypeScript
- Homepage: https://bidout-nestjs-api.vercel.app
- Size: 984 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BidOut Auction V8
#### NestJs Docs: [Documentation](https://docs.nestjs.com/)
#### Prisma Docs: [Documentation](https://www.prisma.io/docs)
#### 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-v8.git
```
#### In the root directory:
- Install all dependencies
```bash
$ npm install
```
- 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. For the test environment, also make sure you create a .env.test file based on the .env.test.example file
- Run Locally
```bash
$ npx prisma db push
```
```bash
$ npm run start:dev
```
- Run With Docker
```bash
$ docker-compose up --build -d --remove-orphans
```
OR
```bash
$ make build
```
- Test Coverage
```bash
$ npm test
```
OR
```bash
$ make tests
```
## Docs
#### SWAGGER API Url: [BidOut Docs](https://bidout-nestjs-api.vercel.app/)
#### POSTMAN API Url: [BidOut Docs](https://bit.ly/bidout-api)
