What is GitHub deploy?
Animmaster Vite Template includes a built-in workflow that allows you to automatically
upload the production build (dist folder)
to a GitHub repository.
This is especially useful for:
- publishing static websites
- GitHub Pages deployments
- quick sharing of project builds
Configuration
To enable GitHub uploading, configure the git section
in template.config.js.
git: {
repo: "https://github.com/username/repository.git",
branch: "main"
}
Deploy command
To build the project and upload it to GitHub, run:
npm run git
This command automatically:
- runs a production build
- creates the
distfolder - pushes the result to the configured branch
Notes & tips
gh-pages)
if you plan to host the project via GitHub Pages.