Skip to content

mend3/ts-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ts-boilerplate

A minimal TypeScript boilerplate with strict configurations and top-level await enabled, designed to kickstart your TypeScript projects with best practices.

Features

  • Strict TypeScript Configurations: Ensures better code quality, type safety, and maintainability.
  • Top-Level Await: Simplifies asynchronous programming by enabling top-level await.
  • ESLint & Prettier: Preconfigured linting and code formatting tools to enforce consistent code style.

Getting Started

We are using pnpm, if you don't want or can't use, feel free to stick with npm or yarn.

  1. Clone this repository to your local machine:

    git clone https://github.com/mend3/ts-boilerplate.git
  2. Install dependencies:

    • Install pnpm:
      npm install -g pnpm # if pnpm is not installed
    • Install dependencies:
      pnpm i
  3. Start coding!

    • To start the project:
    pnpm start
    • To build the project:
    pnpm build

Development

To run the main file and test your code in development mode, use:

pnpm dev

License

This project is licensed under the MIT License. See the LICENSE file for more information.

About

Strict TypeScript boilerplate with Top Level Await

Topics

Resources

License

Stars

Watchers

Forks