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: about 1 month 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 (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-23T03:25:47.000Z (12 months ago)
• Last Synced: 2024-04-16T02:22:26.528Z (9 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

![alt text](https://github.com/kayprogrammer/bidout-auction-v8/blob/main/display/nest.png?raw=true)

#### 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)

![alt text](https://github.com/kayprogrammer/bidout-auction-v8/blob/main/display/display1.png?raw=true)

![alt text](https://github.com/kayprogrammer/bidout-auction-v8/blob/main/display/display2.png?raw=true)

![alt text](https://github.com/kayprogrammer/bidout-auction-v8/blob/main/display/display3.png?raw=true)

![alt text](https://github.com/kayprogrammer/bidout-auction-v8/blob/main/display/display4.png?raw=true)

![alt text](https://github.com/kayprogrammer/bidout-auction-v8/blob/main/display/display5.png?raw=true)

![alt text](https://github.com/kayprogrammer/bidout-auction-v8/blob/main/display/display6.png?raw=true)

![alt text](https://github.com/kayprogrammer/bidout-auction-v8/blob/main/display/display7.png?raw=true)