Node TS Base Project

Description

This is a base project for Node.js using TypeScript. It provides a starting point for building Node.js applications with TypeScript support.

Table of Contents

• Installation
• Usage
• Features
• Contributing
• License

Installation

1. Clone the repository: git clone https://github.com/igordev96/base-project-node-ts.git
2. Navigate to the project directory: cd project-name
3. Install dependencies: npm install

Usage

1. Run npm run dev to watch changes to ts files (hot reload)
2. Start the application: npm run start
3. Build the TypeScript code: npm run build
4. Lint the code using BiomeJS (linter built with Rust): npm run lint

Features

• TypeScript support for better code maintainability and scalability.
• Easily customizable for specific project requirements.
• Includes basic configuration files (tsconfig.json, package.json, etc.).

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature-name).
3. Make your changes.
4. Commit your changes (git commit -am 'Add some feature').
5. Push to the branch (git push origin feature/your-feature-name).
6. Create a new Pull Request.

License

This project is licensed under the MIT License.

---

Feel free to customize this template according to your project's specifics!