readme.md

Node.js Project Template

Modern Node.js project template with TypeScript and ESM support.

Features

• TypeScript with ESM support
• ESLint with modern config
• Node.js Test Runner for testing
• Pino for structured logging
• Zod for runtime type validation
• Docker support
• GitHub Actions CI workflow

Scripts

• npm start - Start the application
• npm run dev - Start development mode with watch
• npm run build - Build TypeScript to JavaScript
• npm test - Run tests
• npm run lint - Check code with ESLint
• npm run lint:fix - Fix ESLint issues
• npm run format - Format code with Prettier
• npm run typecheck - Check TypeScript types

Environment Variables

• NODE_ENV - Application environment (default: development)
• SAMPLE_ENV_VAR - Sample environment variable

Docker

To build and run the Docker container for this application, follow these steps:

1. Build the Docker image:

   docker build -t my-app .

2. Run the Docker container:

   docker run -e NODE_ENV=production my-app

License

MIT