Updating Codebase

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

You can update your codebase to the latest template version. Note that the more customizations you make to your application, the more complex the update process will be. Updating involves merging the latest upstream ShipSaaS template code with your changes using Git, which may require carefully resolving merge conflicts to preserve your custom code.

Pulling Updates

If you initialized your project using a Git repository, you can pull updates directly.

# Add the template repository as the upstream remote repository
git remote add upstream https://github.com/ShipSaaS/shipsaas.git

# Fetch the latest changes from the upstream template
git fetch upstream

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

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

Updating Dependencies

Install any new project dependencies:

bun install

Updating Database

When the update contains database schema changes:

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

bun run db:generate

3. Apply migrations to your databases:

# Apply to your local D1 database
bun run db:migrate:local

# Apply to your remote D1 database
bun run db:migrate:remote

Merging Updates

If you have already linked your project to your own GitHub repository during the Getting Started phase, you can push the updates to your remote repository once the merge is complete:

# Push the update branch to your remote repository
git push origin update-template

# Merge into the main branch and push
git checkout main
git merge update-template
git push origin main

Post-Update Testing

After updating, thoroughly test your application:

1. Start the local development server:

bun run dev

2. Check the console for any errors.
3. Test critical user workflows and operations.
4. Run linting and formatting checks:

bun run lint
bun run format

5. Verify that the production build compiles successfully:

bun run build

Receive Update Notifications

To stay informed about the latest ShipSaaS updates:

1. Watch the GitHub Repository.
2. Follow our X account @ShipSaaS.

Next Steps

Now that you know how to keep your ShipSaaS project up-to-date, explore these related topics:

• Environment Configuration - Configure environment variables

• Deployment - Deploy your website

• Website Configuration - Configure core website settings

• Project Structure - Learn about the template’s project structure

• Editor Setup