Hello and welcome! This is a template repository made for convenience to others by ninjaninja140!
As the title suggests, this is a Node.js based TypeScript Template. If you would like to use the JavaScript version of this template, please go to https://github.com/ninjaninja140/nodejs-template-js This Template has been pre-configured with docker so you can go straight into your Dockerized project with little configuration required!
To begin on your own project, you can either fork this repository and begin your project or you could select this repository at ninjaninja140/nodejs-template-ts as a template when creating a new repository or you could just clone it and work locally!
Just remove the docker folder and the entrypoint.sh file and you should be good to go!
You may also need to remove the validate.yml and ci.yml files as they use Docker to check if the project can be compiled with Docker.
If you are using npm, please remove the yarn.lock and .yarnrc.yml files along with the .yarn directory.
Please also remove the COPY --chown=node:node .yarnrc.yml . line in the Dockerfile if you are using Docker.
You also need to change all the command scripts in package.json that start with yarn to npx.
This project is pre-configured with yarn so if you haven't removed yarn's dependencies if you are using NPM in the For using NPM instead of Yarn section above, you should be fine to run the command below. If you encounter any errors while running it that are not your own computer's errors, please feel free to open an issue so I can fix it.
Running yarn install should install all the necessary development dependencies, after its finished you should be good to go!
If you wish to use NPM in this project, please follow the instructions in the For using NPM instead of Yarn section above before running any commands.
Running npm install after following the section referenced above, you should be ready to start coding!
If you have a different file structure than the one that is currently set up where index.ts is your main file please make sure to set up the test script in the package.json file to point to the file you wish to run.
To test your application run either of the two commands:
- NPM:
npm run test - Yarn:
yarn run testoryarn test
Use CTRL or COMMAND + C to exit.
A pre-configured tsconfig.json and tsup.config.ts file has been made for your convenience, any edits you wish to make, do them now before running the next command.
To compile your project into JavaScript, run our pre-configured yarn build command.
NOTE When you are building this project with Docker, it is compiled in the build stages, so don't worry about compiling before building.
If you haven't done so, please compile your project now. To run your application, run either of the two commands:
- NPM:
npm run start - Yarn:
yarn run startoryarn start
Use CTRL or COMMAND + C to exit.
This project has been pre-configured to use biome.
You can change my current Biome config in the biome.json file, or you can delete it to use another linter.
This project was set up with Docker for convenience to others and myself.
If you do not wish to use Docker in this project, ignore this and go to the If you aren't using Docker sub-section of the Setup & Install section.
If you are using Docker in this project, I have pre-prepared a Dockerfile, change this to your best suit if necessary.
All docker-related content for this project has been set up in the docker folder, which includes development compose files, production compose files and a Dockerfile for building your project.
If you don't already, install Docker Engine or Docker Desktop onto the device you are using to test locally or deploy on.
Running this project in docker is now a bit different as of 08/01/2025, due to the new docker folder, we now have new commands:
Production commands:
- Building the full project:
docker compose -f docker/prod/main.compose.yaml build - Running the full project:
docker compose -f docker/prod/main.compose.yaml up -d - Building only services:
docker compose -f docker/prod/services.compose.yaml build - Running only services:
docker compose -f docker/prod/services.compose.yaml up -d
Development commands:
- Building the full project:
docker compose -f docker/dev/main.compose.yaml build - Running the full project:
docker compose -f docker/dev/main.compose.yaml up -d - Building only services:
docker compose -f docker/dev/services.compose.yaml build - Running only services:
docker compose -f docker/dev/services.compose.yaml up -d(Command automatically runs on boot with VSC for development environments)
If this fails for whatever reason, please try troubleshoot it yourself before opening an issue.
If you haven't already, please build your project before running. Refer to the Building sub-section that should be just above on how to build your project.
Refer to the section above regarding the new deployment commands.
Thank you for using my templates! If you like to use them frequently, why not consider sponsoring or tipping me! My GitHub Sponsors profile is at https://github.com/sponsors/ninjaninja140!
