README.md

Node.js + TypeScript Starter

Key Features

• TypeScript
  • Typed environment variables
  • TypeScript & JavaScript compatibility
  • ES Modules & CommonJS compatibility
• Node.js
  • Live Reload
  • Debugging
• esbuild
  • Fast bundling
  • Fast transpiling
• Biome
  • Fast linting
  • Fast formatting
  • Import sorting
• GitHub
  • One click template
  • Continuous Integration with dependency caching

Prerequisites

• pnpm >=7.27.0
  • Running multiple scripts in parallel
  • Automatic Node.js version management

Getting Started

1. Deploy on Railway or use this template

2. Clone the repository

3. Install dependencies

   pnpm i

4. Create environment file env.ts at the root

   export default {
     PORT: "3000",
   };

   Optionally typecheck environment with zod

   import { z } from "zod";
   
   z.object({
     PORT: z.coerce.number(),
     URL: z.string().url(),
     UUID: z.string().uuid(),
     EMAIL: z.string().email().optional(),
   }).parse(process.env);

Usage

• Development mode (debug)

  pnpm dev

• Production build

  pnpm build && pnpm start