About Mixify

Mixify enhances Spotify's auto-generated playlists by enabling users to create custom playlists based on specific prompts like mood, genre, or artist. Leveraging a large language model (LLM) and Spotify's API, Mixify instantly generates tailored playlists accessible through an intuitive web interface.

2.2 Iteration Docs User Manual Video Demo

Quick Start Guide

1. Install pnpm globally:

   npm install -g pnpm

2. Clone the repo:

   git clone https://github.com/MusaAqeel/2107.git
   cd app

3. Install dependencies:

   pnpm install

4. Create Python Virtual Environment (Conda or Venv):

python -m venv mixify

or

conda create -n mixify

5. Start the Python Backend: Navigate to the /api directory, then:

   uvicorn main:app --reload

6. Start the development server:

   pnpm run dev

Contributing Guide

• Branch Naming: Use [first initial][lastname]/dev/[feature].
  • Example: maqeel/dev/add-login-page
• Pull Requests: Assign each PR to a relevant descriptive issue.
• Merge Process:
  • 2 approval required to merge into staging (development) branch.
  • 2 approvals required to merge into prod (production).2
• Project Progress: Track updates on the project board.

Branch Strategy for TDD

1. Create a feature branch from staging (development branch) and write your test cases and code there.

   git checkout staging
   git checkout -b maqeel/dev/auth-test-cases

2. Create a branch with the same name from prod (production branch, initially empty) and copy only the test cases over.

   git checkout prod
   git checkout -b maqeel/dev/auth-test-cases

3. Push the tests to prod and make a pull request, noting the files being tested.

   git add path/to/tests
   git commit -m "Add authentication test cases"
   git push origin maqeel/dev/auth-test-cases

4. After merging tests into prod, commit the corresponding code from staging to prod to pass each test. (Musa will handle this.)