Project Setup

Automatic Setup (recommended)

Makerkit provides a script to automatically clone the repository and setup the project. Please run the following command to setup the project:

pnpm turbo gen setup

Should this command fail, you can manually setup the project by following the steps below.

Manual Setup

If the command above fails, you can manually setup the project by following the steps below.

Setting Git user name

Please run the following commands to set your Git user name and email:

git config user.name "<your-name>"
git config user.email "<your-email>"

Understanding Git Remotes

In a typical setup, you'll have:

• origin - Your personal repository (where you push your code)
• upstream (optional) - The original Makerkit repository (for pulling updates)

Run the following command to check your current remotes and understand the relationship between them:

git remote -v

Pulling Updates from Upstream

To get the latest changes from the original Makerkit repository:

# Fetch latest changes
git fetch upstream
# Merge changes into your main branch
git checkout main
git merge upstream/main
# Or use pull (fetch + merge)
git pull upstream main

Best practice: Pull upstream updates regularly (e.g., daily) to stay current with bug fixes and new features.

Setting Up Post-Merge Hook

Automatically run pnpm install after pulling updates:

# Create post-merge hook
cat > .git/hooks/post-merge << 'EOF'
#!/bin/bash
echo "Running pnpm install after merge..."
pnpm install
EOF
# Make it executable
chmod +x .git/hooks/post-merge

Now, every time you pull updates, dependencies will automatically install.

Creating a New Branch

For your development work, create a new branch:

# Create and switch to a new branch
git checkout -b feature/your-feature-name
# Or use the new syntax
git switch -c feature/your-feature-name

Windows-Specific Considerations

Path Length Issues

Windows has a 260-character path limit that can cause problems with Node.js projects.

Solution 1: Enable long paths

# Run PowerShell as Administrator
New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" `
  -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force
git config --global core.longpaths true

Solution 2: Clone near drive root

# Clone to C:\projects\ instead of C:\Users\YourName\Documents\Projects\
cd C:\
mkdir projects
cd projects
git clone <repository-url>

Line Ending Configuration

Ensure proper line ending handling:

git config --global core.autocrlf false
git config --global core.eol lf

Avoid OneDrive

Do not clone the repository into a OneDrive-synced folder. This can cause:

• File locking issues
• Node module installation problems
• Build failures
• Performance issues

Next: Environment Variables →