This repo provides a starting point for developing Node.js applications using TypeScript. It includes a basic project structure with pre-configured tools and settings to facilitate rapid application development. The boilerplate includes common features such as express server setup, routing, environment configuration, logging, testing, and debugging. It is a useful resource for developers who want to get started quickly with building Node.js applications using TypeScript.
- Uses TypeScript for type-checking and better code quality
- Comes with a basic project structure and file organization
- Includes pre-configured linting and formatting tools (ESLint and Prettier)
- Includes a Dockerfile for containerization
- Easily extendable for your specific project needs
- Clone the repository:
git clone https://github.com/davydocsurg/nodejs-typescript-boilerplate- Install dependencies:
cd nodejs-typescript-boilerplate
npm i- Start the development server:
npm run dev- Open your browser and go to http://localhost:8080. You should see a "You have reached Nodejs Typescript Boilerplate home page" message.
To build a production-ready version of your application, run:
npm run buildThis will create a dist directory with your compiled TypeScript code.
To containerize your application, you can use the provided Dockerfile.
- Build the Docker image:
docker compose up --build- Run the Docker container:
docker compose upThis will start your application in a Docker container, which you can then access by going to http://localhost:8080 in your browser.
Contributions are welcome! If you find a bug or have a feature request, please open an issue on GitHub. If you would like to contribute code, please fork the repository and submit a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.