Skip to content

A generic template for TypeScript projects

License

habedi/template-typescript-project

TypeScript Project Template

Project Logo

Tests Code Coverage Code Quality Node.js Version Documentation License Managed with npm Makefile


This is a template repository for creating new TypeScript projects. It includes a basic structure, a Makefile for common developmental tasks, and a set of GitHub Actions workflows for running the tests. I am sharing this template in case others find it useful.

Features

  • TypeScript: a basic setup for a TypeScript project.
  • Makefile: for managing common tasks like testing, linting, and formatting.
  • GitHub Actions: for running tests, linting, and publishing packages.
  • Badges: for showing the status of tests, code quality, version, etc.
  • Default files: for configuration, testing, and documentation, like .gitignore, README.md, LICENSE, etc.

Prerequisites

  • Node.js >=20.0.0
  • npm for package management
  • GNU Make

Usage

  1. Use the Use this template button on GitHub to create a new repository based on this template.
  2. Modify the README.md file and other files as needed.
  3. Run make install to install the project dependencies.
  4. Run make help to see all available commands for managing different tasks.

Contributing

See CONTRIBUTING.md for details on how to make a contribution.

License

This template is licensed under the MIT License (LICENSE or https://opensource.org/licenses/MIT)

About

A generic template for TypeScript projects

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks