Web todo template

Version v1.0.0

Setup

1. This project is set up with the pnpm package manager, you need to install it.
2. Fork and clone this repository.
3. From your CLI, move to the project repository with cd.
4. Install the dependencies with pnpm i.

That's all ! You are ready to go.

How to develop with this template ?

This template is based on vite, with some additional tooling. Here are the most important things :

• Use pnpm dev command to launch the development server on localhost:5173.
• Use pnpm check-types to launch the TypeScript type checker. This will verify the project type correctness.
• Use pnpm format to format all project files correctly.
• Use pnpm lint to run the biome linter, and catch some errors statically.

These commands allow you to create good quality commits. Don't forget to lint and format before your commits.

Continuous integration

This repo includes three GitHub actions :

• One to automatically deploy the project to GitHub pages. This workflow executes on each commit in the main branch. You must update the base field in the vite.config.ts file to your repository name for this to work !!! And activate GitHub pages source to GitHub Actions in your repository settings
• One to check the code formatting, linting and types, this one executes on pull requests.
• One to automatically create GitHub releases and changelog, based on your commits messages (they must respect conventional commits standard).