https://github.com/kyletryon/node-typescript-starter

A solid foundation for building modern Node.js applications with TypeScript, sink included.
https://github.com/kyletryon/node-typescript-starter

backend docker node skeleton starter-kit template typescript

Last synced: 2 months ago
JSON representation

A solid foundation for building modern Node.js applications with TypeScript, sink included.

• Host: GitHub
• URL: https://github.com/kyletryon/node-typescript-starter
• Owner: KyleTryon
• License: mit
• Created: 2023-04-17T21:25:08.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-08-15T05:04:13.000Z (almost 2 years ago)
• Last Synced: 2025-03-18T13:15:45.286Z (3 months ago)
• Topics: backend, docker, node, skeleton, starter-kit, template, typescript
• Language: JavaScript
• Homepage:
• Size: 663 KB
• Stars: 16
• Watchers: 2
• Forks: 1
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        


  





  A solid foundation for building modern Node.js applications with TypeScript, sink included.





  

  

    

  

  

    

  

  

    

  

  

    

  



## Features ✨

- Pre-configured TypeScript setup

- Package management with NPM

- Build and Development scripts with watch mode

- Linting with ESLint and Prettier

    - Essential ESLint plugins for improved code quality

- Unit testing with [Vitest](https://vitest.dev/)

- Automated dependency-free `.env`  injection

- Auto-build with `prepare` script

- Dockerfile for production deployment

- Docker Compose for local development

- GitHub Actions for CI/CD

## Getting Started 🌱

- Clone or download this repository to start a new Node.js project

- Run `npm install` to install all dependencies

- Create a `.env` file in the root of your project if needed

- Start the development server by running npm run `start:dev`

- Build your awesome Node.js application with TypeScript!

## Use The Template 🧩

Use this repository as the template for your next project or try it out now in a codespace!



## Available Scripts 📜

- `npm run env:load`: Loads environment variables from the `.env` file

- `npm run clean`: Cleans the project by removing the `dist` directory

- `npm run build`: Builds the TypeScript project, outputting ES modules

- `npm run start`: Runs the compiled JavaScript application

- `npm run start:dev`: Starts the development server with live-reloading

- `npm run format`: Formats your code using Prettier

- `npm run lint`: Runs ESLint to check for code quality issues

- `npm run lint:fix`: Automatically fixes code quality issues using ESLint

- `npm run test`: Runs unit tests with Vitest

- `npm run coverage`: Generates a [`c8`](https://vitest.dev/guide/coverage.html) code coverage report

- `npm run docker:build`: Builds a Docker image for production deployment

- `npm run docker:run`: Runs the Docker image in a container

## Contributing 🤝

Feel free to contribute to this project by opening issues or submitting pull requests. We appreciate any feedback and improvements to make this starter even better!

## License 📄

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---

Happy coding! 🎉