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
• Setup WSL2 on Windows (skip if done)
• Install Docker
• Install Yarn (for backend dev only)
• Install Postgres (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