Skip to content

lumen-limitless/template-tsnode

Repository files navigation

TypeScript Node.js Template

This repository provides a robust template for developing Node.js applications using TypeScript. It's designed to help you quickly start new projects with a solid foundation and best practices in place.

Features

  • TypeScript Support: Leverage the power of static typing for more reliable code.
  • ESBuild: Fast bundling and minification for production builds.
  • tsx: Automatic server restarts during development for a smoother workflow.
  • Jest: Integrated testing framework for writing and running tests.
  • ESLint: Linting tool to help maintain code quality and consistency.
  • Prettier: Code formatter to ensure uniform code style across your project.
  • NPM Scripts: Pre-configured scripts for common tasks like building, testing, and running the application.

Getting Started

  1. Clone this repository
  2. Run npm install to install dependencies
  3. Use npm run dev to start the development server
  4. Write your code in the src directory

Available Scripts

  • npm run build: Build the project for production
  • npm run dev: Start the development server with hot-reloading
  • npm run lint: Run ESLint to check for code issues
  • npm test: Run Jest tests
  • npm run coverage: Run tests with coverage report
  • npm start: Run the production build

Project Structure

  • src/: Source code directory
  • tests/: Test files
  • build/: Compiled output (generated after build)

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published