Updating the Codebase

MkSaaS is regularly updated with new features, bug fixes, and security patches. This guide explains how to update your project to the latest version.

While updating your codebase to the latest version is possible, it's important to note that the more customizations you make to your application, the more complex the update process becomes, so please be patient. This is because updates involve rebasing your custom code on top of the latest MkSaaS template code using Git, which may require resolving merge conflicts and careful handling to preserve your customizations.

Update Process

Method 1: Using Git (Recommended)

If you started your project using the Git repository, you can pull updates directly. There are two approaches:

Option A: Merge Approach (Safer)

Choose this option if you want a safer update process with clear merge points.

# Add the upstream remote if you haven't already
git remote add upstream https://github.com/MkSaaSHQ/mksaas-template.git

# Fetch the latest changes
git fetch upstream

# Create a new branch for the update
git checkout -b update-mksaas

# Merge the changes (resolve conflicts if necessary)
git merge upstream/main

Option B: Rebase Approach (Cleaner History)

Choose this option if you prefer a linear history. This approach is more advanced and may require more Git experience to resolve conflicts.

# Add the upstream remote if you haven't already
git remote add upstream https://github.com/MkSaaSHQ/mksaas-template.git

# Fetch latest changes and rebase
git pull upstream main --rebase

If you have any merge conflicts, you will have to resolve them manually. If you are not sure how to do this, please refer to the Git documentation.

Method 2: Manual Update

If you prefer to update manually or didn't use Git:

1. Download the latest version of MkSaaS
2. Compare your customized files with the new version
3. Apply changes selectively, focusing on:
   • package.json for dependency updates
   • Configuration files like next.config.js
   • Database schema updates in src/db/schema.ts

Dependency Updates

To install new dependencies:

pnpm install

npm install

yarn install

bun install

Database Schema Updates

When updates include database schema changes:

1. Check the schema changes in the src/db/schema.ts file
2. Generate migration files:

pnpm run db:generate

npm run db:generate

yarn db:generate

bun run db:generate

3. Apply migrations to the database with:

pnpm run db:migrate

npm run db:migrate

yarn db:migrate

bun run db:migrate

Testing After Updates

After updating, thoroughly test your application:

1. Run the development server:

pnpm run dev

npm run dev

yarn dev

bun run dev

2. Check for console errors
3. Test critical user flows
4. Run linting and formatting:

pnpm run lint
pnpm run format

npm run lint
npm run format

yarn lint
yarn format

bun run lint
bun run format

5. Check build:

pnpm run build

npm run build

yarn build

bun run build

Keeping Up with Changes

To stay informed about updates:

1. Watch the GitHub repository
2. Check the Roadmap regularly
3. Join the Discord community
4. Follow MkSaaS on Twitter/X and other social platforms

Video Tutorial

Next Steps

Now that you understand how to keep your MkSaaS project up to date, explore these related topics: