Skip to content
/ quickstart-node-ts Public template

A quick start boilerplate for Node.js with TypeScript, ESLint. CI/CD ready with GitHub Actions (Fly.io)

Notifications You must be signed in to change notification settings

4D5A90/quickstart-node-ts

Repository files navigation

Overview

Easily kickstart your Node.js projects using TypeScript. Comes pre-configured with ESLint for code linting and GitHub Actions for seamless CI/CD integration via Fly.io. This template enables you to swiftly set up your Node.js applications, ensuring robustness, maintainability, and scalability right from the start.


Features

  • TypeScript Support: Write your Node.js code in TypeScript, enabling type safety and improved developer productivity.

  • Biome Integration: Catch potential errors and enforce consistent code style with Biome, ensuring code quality throughout your project. And maintain consistent code formatting effortlessly with, enhancing code readability and collaboration within your team.

  • esbuild for Bundling: Leverage esbuild to bundle your TypeScript code efficiently, optimizing performance and reducing bundle sizes.

  • CI/CD Ready: Utilize GitHub Actions for automated testing, building, and deployment processes, making your development workflow efficient and streamlined.


Getting Started

System Requirements:

  • Node: version 20.13.0 (LTS) or higher
  • pnpm: version 9.1.0 or higher

Installation

From source

  1. Clone the quick-start-node-ts repository:
git clone https://github.com/4D5A90/quick-start-node-ts my-ts-project
  1. Change to the project directory:
cd my-ts-project
  1. Install the dependencies:
pnpm install

Usage

From source

Run quick-start-node-ts using the command below:

pnpm build && pnpm start

to run the project in development mode:

$ > pnpm dev

CI/CD

About

A quick start boilerplate for Node.js with TypeScript, ESLint. CI/CD ready with GitHub Actions (Fly.io)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published