https://github.com/sabarivasan-velayutham/auctioneer

https://github.com/sabarivasan-velayutham/auctioneer

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/sabarivasan-velayutham/auctioneer
• Owner: Sabarivasan-Velayutham
• Created: 2024-07-06T06:35:14.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-07-06T06:45:50.000Z (6 months ago)
• Last Synced: 2024-07-06T07:46:00.654Z (6 months ago)
• Language: JavaScript
• Size: 362 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Auctioneer

This is a real-time auction and bidding app built with the MERN stack (MongoDB, Express, React, and Node.js) and socket.io. Users can participate in live auctions and place bids in real-time.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

## Prerequisites

- Node.js >= 18.12.1

- NPM >= 8.19.2

- MongoDB

## Installation

  1. Clone the repository

  2. Go to `client` and `server` directory one by one and install dependencies with command shown at 3rd step.

    $ cd client/

    // And

    $ cd server/

  3. Install the dependencies

    $ npm install

## Configure App

You have to set the environment variables of your configuration before starting the app.

### 1. Environment variables for `client`

Create a `.env` file at `auctioneer/client/` directory and set the following environment variables starting with prefix `VITE_`

    VITE_BASE_API_URL={api_url_of_the_backend} // e.g: http://localhost:8000/api

    VITE_SOCKET_URL={url_of_backend} // e.g: ws:localhost:8000

### 2. Environment variables for `server`

Create a `.env` file at `auctioneer/server/` directory and set the following environment variables.

    PORT=8000 // You can set any port number that is available but make sure to correctly include it in client environment variables.

    BASE_URL_PREFIX={api_prefix} // e.g: `/api`

    DB_NAME=Auctioneer

    DB_CONNECTION_STRING={your_mongodb_connection_uri}

    SALT=10 // 10 is the recommended salt here.

    SECRET={your_jwt_secret} // e.g: shhhh123.

    ORIGIN={where_client_is_running} // e.g: http://localhost:3000

    DEFAULT_AVATAR={cloud_url_for_an_image} // Cloudinary is recommended.

    CLOUDINARY_CLOUD_NAME={your_cloudinary_cloud_name} // Shown in cloudinary dashboard.

    CLOUDINARY_API_KEY={your_cloudinary_api_key} // Shown in cloudinary dashboard.

    CLOUDINARY_API_SECRET={your_cloudinary_api_secret} // Shown in cloudinary dashboard.

## Running The Project

### Start Server (Node API)

    $ cd auctioneer/server // go to server directory

    $ npm run dev // run backend with hot reloading.

    // or you can run the backend with standard command

    $ node server.js

### Start Client (React app [VITE])

    $ cd auctioneer/client // go to client directory

    $ npm run dev

## Deployment

The app can be deployed to a hosting platform such as Render or Heroku.

## Built With

- [MongoDB](https://www.mongodb.com/)

- [Express](https://expressjs.com/)

- [React](https://reactjs.org/)

- [Node.js](https://nodejs.org/)

- [Socket.io](https://socket.io/)

- [cloudinary.com](https://cloudinary.com/)