🔮Getting Started

Before getting started, all the system requirements are installed correctly. Backend are configured into port 3000 and frontend is on 5173 by default.

Requirements:

Bun.js. -> 1.1.24

Docker -> 27.1.1, build 6312585

Unix -> 12.7.6 (MacOS Monterey)

---

Installation:

Backend Setup

cd backend && cp .env.example && bun install

.env.example consists of Ngrok (Production Plan) configuration keys. Also make sure docker is running in background.

NGROK_API_KEY=String # https://dashboard.ngrok.com/api-keys
NGROK_AUTH_TOKEN=String # https://dashboard.ngrok.com/get-started/your-authtoken
NGROK_DOMAIN=String # e.g.ming.ngrok.dev or your custom domain https://dashboard.ngrok.com/cloud-edge/domains

Frontend Setup

cd frontend && bun install

---