TypeScript Template

A fully-configured TypeScript project template.

ℹ️ About The Project

This is a fully-configured TypeScript project template, featuring...

• Yarn for package management and project scripts.
• A boilerplate TypeScript configuration.
• Linting and formatting with ESLint, Prettier, and the AirBnB style guide.
• Integration with Jest for test-driven development.
• Pre-commit hooks with Husky, CommitLint, and LintStaged.
• Pre-built GitHub issue templates and workflows.

⚙️ Installation

1. Click on "use this template" to create your repository.
2. Use git clone to copy the new repository to your machine.
3. Run yarn install to install all of the project dependencies.

🧰 Usage

1. After installing dependencies, you can start coding in the src folder.
2. Setup your unit tests in the tests folder, or remove it and uninstall Jest if you don't need it. Make sure to remove all Jest-related packages, including the ESLint plugin, if you won't need it.
3. Change README.md and the LICENSE page as needed.
4. You can use yarn run lint:fix, yarn run format:fix, and yarn run test to ensure your project is healthy.
5. Ensure your commits meet Conventional Commit requirements, as enforced by Husky and CommitLint. If the hooks did not properly install, run yarn husky install.

📜 License

Distributed under the MIT License. See LICENSE for more information.