Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tenosiswono/auction

Sample T3 stacks about auction online system, exercise project
https://github.com/tenosiswono/auction

inngest nextjs pusherjs react-query supabase t3-stack trpc typescript

Last synced: 2 months ago
JSON representation

Sample T3 stacks about auction online system, exercise project

Host: GitHub
URL: https://github.com/tenosiswono/auction
Owner: tenosiswono
Created: 2023-03-27T16:49:43.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-04-02T01:17:28.000Z (over 1 year ago)
Last Synced: 2024-09-27T13:01:21.908Z (3 months ago)
Topics: inngest, nextjs, pusherjs, react-query, supabase, t3-stack, trpc, typescript
Language: TypeScript
Homepage: https://auction.teno.dev
Size: 3.93 MB
Stars: 8
Watchers: 1
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # [AuctionHive](https://auction.teno.dev)

[![codecov](https://codecov.io/gh/tenosiswono/auction/branch/main/graph/badge.svg?token=34SH7KLJZ1)](https://codecov.io/gh/tenosiswono/auction)

Realtime Auction System

https://auction.teno.dev

## Setup

To get started with the project, follow these steps:

```bash

git clone [email protected]:tenosiswono/auction.git

```

Navigate to the project directory.

```bash

cd auction

```

Install the dependencies.

```bash

npm install

```

Create an environment file.

```bash

cp env.example .env

```

Edit the environment file and fill in your postgres connection string

```bash

# Prisma DB

DATABASE_URL="postgres://:@:/"

```

Edit the environment file and fill in coresponding `#supabase` env from [Supabase](https://supabase.com/) project

```bash

#supabase

SUPABASE_DOMAIN=odfdyvontbfhssqawmbj.supabase.co

SUPABASE_URL=https://.supabase.co

SUPABASE_KEY=

SUPABASE_BUCKET=

IMAGE_SERVER=https://.supabase.co/storage/v1/object/public/bucket-name

```

Edit the environment file and fill in coresponding `#inngest` env from [Inngest](https://www.inngest.com/) project 

```bash

#inngest

INNGEST_EVENT_KEY="local"

INNGEST_SIGNING_KEY=

```

Edit the environment file and fill in coresponding `#pusher` env from [Pusher](https://pusher.com/) project 

```bash

#pusher

PUSHER_APP_ID=""

NEXT_PUBLIC_PUSHER_KEY=""

PUSHER_SECRET=""

NEXT_PUBLIC_PUSHER_CLUSTER=""

```

Migrate Prisma DB

```bash

npx prisma migrate dev

```

Start the web development server.

```bash

npm run dev

```

Open on your browser `http://localhost:3000`

## Test

- [x] Frontend Unit Test

- [x] Server Unit Test

- [ ] End-to-end Test

- [ ] DB Test

To run the test

```bash

npm run test

```

To collect coverage of the test

```bash

npm run coverage

```

To lint on sources

```bash

npm run lint

```

## Architecture

### Stacks

- [Next.js](https://nextjs.org) Base Framework

- [NextAuth.js](https://next-auth.js.org) Authentication

- [Prisma](https://prisma.io) DB Orm

- [Tailwind CSS](https://tailwindcss.com) CSS framework

- [tRPC](https://trpc.io) end-to-end typesafe APIs

- [Supabase](https://supabase.com/) Uploading Image, and Postgres Server

- [Inngest](https://www.inngest.com/) Ship Background Jobs, Crons, Webhooks, and Workflows

- [Vitest](https://vitest.dev/) Test Framework

- [Pusher](https://pusher.com/) Websocket to handle realtime data

### ERD

```mermaid

erDiagram

	Auction {

		String id PK  "cuid()"

		String title

		String image

		Float startingPrice

		Float currentPrice

		Int duration

		DateTime startDate  "nullable"

		DateTime endDate  "nullable"

		DateTime createdAt  "now()"

		DateTime updatedAt  "now()"

		String creatorId FK

		String status

		String winnerId FK  "nullable"

	}

	Bid {

		String id PK  "cuid()"

		Float amount

		String bidderId FK

		String auctionId FK

		DateTime createdAt  "now()"

		DateTime updatedAt  "now()"

	}

	DepositHistory {

		String id PK  "cuid()"

		String userId FK

		Float amount

		String status

		DateTime createdAt  "now()"

		DateTime updatedAt  "now()"

	}

	Account {

		String id PK  "cuid()"

		String userId FK

		String type

		String provider

		String providerAccountId

		String refresh_token  "nullable"

		String access_token  "nullable"

		Int expires_at  "nullable"

		String token_type  "nullable"

		String scope  "nullable"

		String id_token  "nullable"

		String session_state  "nullable"

	}

	Session {

		String id PK  "cuid()"

		String sessionToken

		String userId FK

		DateTime expires

	}

	User {

		String id PK  "cuid()"

		String name  "nullable"

		String email  "nullable"

		DateTime emailVerified  "nullable"

		String image  "nullable"

		String password

		Float deposit

	}

	VerificationToken {

		String identifier

		String token

		DateTime expires

	}

	Auction }o--|| User : creator

	Auction }o--|| User : winner

	Bid }o--|| User : bidder

	Bid }o--|| Auction : auction

	DepositHistory }o--|| User : user

	Account }o--|| User : user

	Session }o--|| User : user

```

### Auciton Creator Sequence Diagram

```mermaid

sequenceDiagram

    participant Creator

    participant AuctionSystem

    participant InngestJobWorker

    Creator->>AuctionSystem: Create Auction

    AuctionSystem-->>Creator: Auction Created

    Creator->>AuctionSystem: Publish Auction

		AuctionSystem->>InngestJobWorker: Create Scheduller at endDate

    AuctionSystem-->>Creator: Auction Published

    Note left of InngestJobWorker: After Scheduller at endDate

		InngestJobWorker->>AuctionSystem: Update auction to complete, select winner, refund lost bidder

```

### Auction Bidder Sequence Diagram

```mermaid

sequenceDiagram

    participant Bidder1

    participant Bidder2

    participant AuctionSystem

		Bidder1->>AuctionSystem: Bid on Auction 1, price: 100

		AuctionSystem->>Bidder1: Update on websocker currentPrice 100

		AuctionSystem->>Bidder2: Update on websocker currentPrice 100

		Bidder2->>AuctionSystem: Bid on Auction 1, price: 200

		AuctionSystem->>Bidder1: Update on websocker currentPrice 200

		AuctionSystem->>Bidder2: Update on websocker currentPrice 200

```

### Design 

![Home](docs/scr.png?raw=true "Home")

![List](docs/list.png?raw=true "List")

Inspired by [ClickBids. A new way of winning in 11 clicks](https://www.behance.net/gallery/150684529/ClickBids-A-new-way-of-winning-in-11-clicks)

# License

## MIT License

Copyright (c) 2023 Teno Siswono

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.