Local Installation and Development Steps
This doc provides a comprehensive guide on how to install and set up the ZTO SaaS Starter Kit in your local environment. From cloning the repository to configuring your development environment, we'll walk you through each essential step to ensure you can successfully launch and begin using our SaaS starter kit.
Clone Repository
1. Clone the repository or download the GitHub ZIP source code
git clone git@github.com:zto-dev/zto-next-saas-kit.git your-new-repo
Or directly download the ZIP file from the GitHub page and extract it.
2. Remove the .git folder and set up the repository as your own GitHub private repository
cd your-new-repo
pnpm dlx rimraf .git
git init
git add .
git commit -m "Initial commit"
git remote add origin https://github.com/your-username/your-new-repo.git
git push -u origin main
Note: If you need to update the repository, we recommend manually modifying based on our commit history or downloading the latest version for development. This ensures your custom changes won't be overwritten.
Run Development Environment
1. Install dependencies
pnpm i
2. Start the development server
pnpm dev
Start Supabase Environment
1. Start Docker
Ensure your Docker Desktop application is running.
2. Start Supabase local development environment
pnpm run supabase:web:start