Skip to content

Xitaorz/Resonate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

198 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CS348 Project

This project consists of a backend server and a frontend web application.

Getting Started

Backend Setup

  1. Navigate to the server directory:

    cd server
  2. Please follow the instructions in the server README to set up and start the backend.

The backend provides a API and handles all database operations. You can run it using Docker Compose (recommended) or a local Python environment.

Frontend Setup

  1. Navigate to the web directory:

    cd web
  2. Install dependencies:

    pnpm install
  3. Start the development server:

    pnpm start

Project Structure

  • server/ - Backend API server (Python/Flask + MySQL)
  • web/ - Frontend web application (React + TanStack Router)

Quick Start (Full Stack)

  1. Start the backend (in one terminal):
    cd server
    docker-compose up

The production dataset should be automatically loaded to the database when running docker-compose up.

  1. Start the frontend (in another terminal):
    cd web
    pnpm install
    pnpm start

The backend API will run on http://localhost:3000 and the frontend will run on its own port (typically http://localhost:5173).

Manually Importing Production Dataset

With the database container running, change the dir to server and enter venv:

cd server
python -m venv venv
source venv/bin/activate

Then run manage script with init argument:

python -m src.manage init

Make sure when running this command, there is no table/view in the database. If there is any table you might need to drop them.

About

The Project Repo for CS348

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors