This project serves as a template for Node.js applications. It's designed to provide a basic structure, including essential dependencies and configurations, to kickstart any Node.js project.

These instructions will get your copy of the project up and running on your local machine for development and testing purposes.

Before you begin, ensure you have met the following requirements:

• Node.js: Version 18.19.0 or later. Node.js is the runtime environment required to run JavaScript code outside of a browser.
• yarn: Version 1.22.0 or later. yarn is the package manager for JavaScript, used to install and manage dependencies.

To check if you have Node.js and yarn installed, run the following commands in your terminal:

node --version
yarn --version

If you don't have Node.js or yarn installed, you can download them from the following links:

• Node.js
• yarn

To install the project, follow these steps:

1. Clone the repository:

git clone <repository-url> <folder_path_you_want_to_install_it_in>

2. Navigate to the project directory:

cd node-app-template

3. Install the project dependencies:

yarn install

To start the project, run the following command:

yarn dev

The project will start on http://localhost:3000.

To run the project tests, use the following command:

yarn test

To contribute to the project, follow these steps:

1. Fork the project.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes.
4. Commit your changes (git commit -am 'Add new feature').
5. Push to the branch (git push origin feature-branch).
6. Create a new Pull Request.
7. Wait for your PR to be reviewed.
8. Once approved, merge the branch.
9. Delete the feature branch.
10. Sync your changes to the main repository.
11. Repeat.
12. Enjoy!
13. 🎉

This project uses the following license: MIT.

• Node.js
• Express
• TypeScript
• yarn
• Jest
• ESLint
• Prettier
• Husky
• Commitlint
• dotenv