Skip to content

Latest commit

 

History

History
44 lines (39 loc) · 1.05 KB

README.md

File metadata and controls

44 lines (39 loc) · 1.05 KB

Companion

Companion is your on-demand accompanist, allowing you to practice with professional-quality accompaniment anytime, anywhere.

System Requirements

  • OS: Windows 10/11 or Linux (macOS may work but is untested)
  • Memory: 16 GB RAM (recommended)
  • Disk Space: 10 GB for library installations
  • Audio: Microphone and headphones (to prevent feedback)

Getting Started

Running the Backend Server Locally

  1. Open a terminal and navigate to the backend directory:
    cd backend
  2. Install dependencies:
    python setup.py install
  3. Start the Flask server:
    python app.py

Running the Frontend Locally

  1. Install Node.js from nodejs.org.
  2. Install the Expo CLI:
    npm install -g expo-cli
  3. Navigate to the frontend directory:
    cd frontend/companion-app
  4. Install project dependencies:
    npm install
  5. Start the frontend:
    npm run web