QFlare Back-End

Description

QFlare is a platform that allows users to enhance their logic skills with quizzes. This repository contains the back-end of the QFlare platform.

Requirements

• Node.js >= v18.16.0 or Bun >= v1.0.0
• MySQL >= v8.0.0

Installation

1. Clone the repository

git clone https://github.com/Capstone-Buddies/qflare-back-end.git

2. Install dependencies

npm:

npm install

yarn:

yarn install

bun:

bun install

3. Create a .env file in the root directory and add the following environment variables:

PORT=
MYSQL_DB_HOST=
MYSQL_DB_USER=
MYSQL_DB_PASSWORD=
MYSQL_DB_NAME=
JWT_SECRET=
ML_API_BASE_URL=
GCP_BUCKET_NAME=
GCP_PROJECT_ID=
GCP_KEYFILE_PATH=

4. Run the database migrations

npm:

npm run migration:generate
npm run migrate:node

yarn:

yarn migration:generate
yarn migrate:node

bun:

bun migration:generate
bun migrate:bun

Usage

npm:

npm run dev:node

yarn:

yarn dev:node

bun:

bun dev:bun

The server will be running on http://localhost:3000

Build

npm:

npm run build:node

yarn:

yarn build:node

bun:

bun build:bun

API Documentation

• API Documentation