MuseMVP

Clone MuseMVP, configure remotes, install dependencies, and run your dev server in minutes.

Prerequisites

Before starting, ensure the following tools are installed:

Node.js 22.x

Must match the engines field in package.json. Download from nodejs.org.

pnpm 10.x

Project package manager. Install command: npm i -g pnpm (Website)

PostgreSQL ≥ 13

Supports local installation (Download) or serverless cloud databases like Neon.

Clone & Setup

Clone the repository

Prerequisite: Git installed

Ensure you have Git installed on your local machine before proceeding. You can download Git from git-scm.com.

We recommend using SSH to clone (requires configuring SSH keys in advance):

git clone git@github.com:musemvp/musemvp.git
cd musemvp

Alternatively, you can use HTTPS if SSH is not configured:

git clone https://github.com/musemvp/musemvp.git
cd musemvp

git clone Docs

git-scm.com

Git remote

After cloning the repository, we recommend setting the original repository as upstream for easier syncing of official updates.

Remove the default origin remote:

git remote rm origin

Add the official repository as upstream:

git remote add upstream git@github.com:musemvp/musemvp.git

Once you have your own repository set up, add your repository as the origin (if applicable):

git remote add origin <your-repository-url>

Verify your remote setup:

git remote -v

git remote Docs

git-scm.com

Install dependencies

pnpm install

Staying Up To Date

If you are developing based on a Fork, you need to regularly pull the latest changes from the upstream repository to prevent your code from diverging too far from the main branch:

git pull upstream main

If conflicts occur, resolve them first before committing the merge result:

# Check files with conflicts
git status

# Stage after resolving conflicts
git add .

# Finish merge commit
git commit -m "chore: merge upstream changes"

Suggested Frequency

It's recommended to pull the latest code daily (preferably with your morning coffee ☕) to keep your local environment synced with the main branch.

Updating Codebase

Pull latest code

git pull upstream main

Reinstall dependencies

If dependencies have changed (e.g., updates in package.json), you must reinstall them:

pnpm install

Run database migrations

If there are changes to the database Schema, run the migration command:

pnpm db:migrate

Do Not Skip Dependency Installation

Always re-run pnpm install after pulling code changes to ensure dependency versions match the lockfile and to avoid runtime errors.

Cloning Repository