https://github.com/dhzdhd/bidwave

A realtime auction platform built on SvelteKit and Strapi
https://github.com/dhzdhd/bidwave

auction playwright sass socket-io strapi sveltekit typescript

Last synced: 15 days ago
JSON representation

A realtime auction platform built on SvelteKit and Strapi

• Host: GitHub
• URL: https://github.com/dhzdhd/bidwave
• Owner: dhzdhd
• License: gpl-3.0
• Created: 2023-08-18T04:49:43.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-11-09T14:04:09.000Z (about 1 year ago)
• Last Synced: 2024-02-19T05:34:48.715Z (11 months ago)
• Topics: auction, playwright, sass, socket-io, strapi, sveltekit, typescript
• Language: Svelte
• Homepage: https://bidwave.vercel.app/
• Size: 1.54 MB
• Stars: 0
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bidwave

A realtime auction platform built on SvelteKit and Strapi

## Synopsis structure

- Title

- Introduction

- Motivation

- Objective

- Methodology

- Members

- Roles

- Modules

- Software

- Learning Curve

- Process Model

- Conclusion

- References

## Setup

### GitHub

- Fork the repository and clone it locally.

- Create a new branch with the name being your feature/bugfix in short. For example -

  - `feat/login-page`

  - `fix/setup-error`

- After implementing the feature/fix, push it to your fork and create a pull request.

### Prerequisites

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

- Setup [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install) on Windows (skip if done)

- Install [Docker](https://www.docker.com/products/docker-desktop/)

- Install [Yarn](https://yarnpkg.com/getting-started/install) (for backend dev only)

- Install [Postgres](https://www.postgresql.org/download/) (for backend dev only)

- Clone the repository - `git clone https://github.com/dhzdhd/bidwave.git`

### Backend

- After cloning the repository, `cd backend`

- Create a file named `.env`

- Populate `.env` file as per `.env-example` file (copy-paste)

- Change the following variables in `.env` file

  - DATABASE_HOST - 127.0.0.1

  - DATABASE_USERNAME - your local postgres username

  - DATABASE_PASSWORD - your local postgres password

- Run `yarn install`

- Run `yarn run develop`

### Backend - for frontend dev

- After cloning the repository, `cd backend`

- Create a file named `.env`

- Populate `.env` file as per `.env-example` file (copy-paste)

- Make sure Docker engine is up and running (start Docker Desktop to be sure)

- Run `docker compose up`

### Frontend

- `cd frontend`

- `npm install`

- Create a file named `.env`

- Populate `.env` file as per `.env-example` file (copy-paste)

- Change the following variables in `.env` file

  - KEY_ID - RazorPay key ID

  - PUBLIC_KEY_ID - Same as KEY_ID

  - KEY_SECRET - RazorPay key secret

  - PUBLIC_CMS_URL - the URL of the CMS (defaults to localhost if left blank)

- `npm run dev`