A repository aimed at serving as a template to implement projects using TypeScript on the client side, providing basic configurations for using Conventional Commits, Prettier, ESLint, and Jest. It also includes a setup for use within a Dev Container, featuring optimized VSCode configurations for working with these technologies. Lastly, it incorporates GitHub Actions that automate the project build and release.
Note This template repository extends from this one. It adds webpack with Sass to be able to create a more robust application
In order to proceed with using this template, you need to:
- Create a repository from this template
- Adjust the following values in the default
package.json:nameversion(it's recommended to use0.0.0so that the release workflow can adjust it)descriptionprivaterepository.urlkeywordsbugs.urlhomepagelicense(if necessary)
- Remove the
CHANGELOG.md - Modify the
LICENSEfile (if necessary) - Edit the
README.md. Update texts and create new badges for build workflow and release workflow since they currently point to the template repository - Run
npm installto install the dependencies - You can now start working in
./srcusing the files there as templates and/or creating new ones
Note Enable code scanning with CodeQL and add the status badge to the
README.md
Warning The release workflow uses a bot that needs to have write access to the repository to create new releases, tags, and the
CHANGELOG.md. If you are using a personal repository, to allow the bot to work smoothly, you shouldn't protect the branch. If you are using an organization's repository, you can protect the branch and add the bot as an owner to enable it to perform its tasks)
Detailed changes for each release are documented in CHANGELOG.md.
This work is published under MIT License.
Always happy to receive a greeting on: