Auctionion

Socket React App

Table of Contents

1. Getting Started
   • Installation
2. Usage
   • Functionality
   • Notes

Getting Started

Installation

1. Clone the repo

   git clone https://github.com/sashkhen/auctionion.git

2. Update network address for client and server to point at each other: ./client/src/consts.js, ./server/variables.env

3. Start a project

   # to run server
   cd server
   npm i
   npm run start
   
   # to run client
   cd client
   npm i
   npm run start

Usage

Navigate to the link displayed in the terminal (💻 / client).

Functionality

• Create /asset

• Browse /assets

• Create /auction

• Browse /auctions

• Browse /auction/:id

• Update /auction/:id

• Delete /auction/:id

• Make a bid when /auction/:id is active

Notes

Auctions are implemented as socket.io rooms. This means you need to be browsing a room to see auction updates realtime.