UNPKG

@ssit-hub/mvp-generate-template

Version:

A beautiful CLI tool to quickly generate MVP project templates with modern frameworks and best practices

77 lines (55 loc) 1.43 kB
# Basic Node.js Application with TypeScript and ESBuild A simple Node.js application template combining TypeScript for type safety and ESBuild for fast bundling. ## Features - TypeScript for type safety - ESBuild for fast bundling - Development with watch mode - Production builds with minification - Source maps for development - Type checking ## Getting Started ### Prerequisites - Node.js >= 16.0.0 - npm >= 7.0.0 ### Installation 1. Install dependencies: ```bash npm install ``` ### Running the Application #### Development mode (with watch): ```bash npm run dev ``` #### Build for production: ```bash npm run build:prod ``` #### Run production build: ```bash npm start ``` #### Type checking only: ```bash npm run typecheck ``` ## Project Structure ``` src/ ├── index.ts # Main application entry point dist/ ├── index.js # Built application (generated) esbuild.config.mjs # ESBuild configuration tsconfig.json # TypeScript configuration ``` ## Environment Variables - `PORT` - Port number for the application (default: 3000) - `NODE_ENV` - Environment (development/production) ## Scripts - `npm start` - Run the built application - `npm run dev` - Run in development mode with watch - `npm run build` - Build for development - `npm run build:prod` - Build for production with minification - `npm run typecheck` - Check types without compilation ## License MIT