Contribution

Hi! We're really excited that you are interested in contributing to vite-ts-starter (VTS). Before submitting your contribution, please make sure to take a moment and read through the following guidelines:

• Code of Conduct
• Pull Request Guidelines

Pull Request Guidelines

• Checkout a topic branch from the relevant branch, e.g. main, and merge back against that branch.

• If adding a new feature:

  • Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.

• If fixing bug:

  • Provide a detailed description of the bug in the PR. Live demo preferred.

• It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.

• Commit messages must follow the commit message convention so that changelogs can be automatically generated.

Development Setup

You will need pnpm

After cloning the repo, run:

# install the dependencies of the project
$ pnpm install

Setup VTS Dev Environment

The easiest way to start testing out VTS is to start the local development environment. You can do this by running:

$ pnpm run dev

After executing the command, visit http://localhost:5173 and try modifying the source code. You'll get live updates as you make changes.