https://github.com/david-pena/node-typescript-template

Nodejs with Typescript template for API project.
https://github.com/david-pena/node-typescript-template

nodejs oss typescript

Last synced: 7 days ago
JSON representation

Nodejs with Typescript template for API project.

• Host: GitHub
• URL: https://github.com/david-pena/node-typescript-template
• Owner: David-Pena
• Created: 2024-03-13T03:37:48.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-05-04T04:58:42.000Z (7 months ago)
• Last Synced: 2024-10-12T05:12:27.352Z (about 1 month ago)
• Topics: nodejs, oss, typescript
• Language: TypeScript
• Homepage:
• Size: 34.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Node.js TypeScript Starter Template

This starter template provides a robust foundation for building Node.js applications with TypeScript. It comes pre-configured with essential tools and structure to kickstart your project development.

## Features

- **Prettier and Eslint Setup**: Ensures code consistency and quality.

- **Nodemon Configuration**: Automatic server restarts on file changes for seamless development.

- **Modular Structure**: Organized into distinct directories for easy navigation and maintenance.

- **HTTP Client**: Includes an HttpClient for handling HTTP requests using Axios.

- **Types Definition**: Centralized location for storing type definitions used throughout the project.

## Structure

- **`index.ts`**: Entry point of the application, where the main route configuration is set up.

- **`src/router`**: Contains route definitions.

- **`src/controller`**: Houses controllers responsible for handling requests and responses.

- **`src/models`**: Contains data models and logic, simulating service functionalities.

- **`src/core`**: Core functionalities of the application.

  - **`http`**: Contains the HTTP client for making external requests.

- **`src/types`**: Holds type definitions used across various files.

Additional directories such as `middlewares`, `utils`, and `vendor` can be added as needed for handling middleware, utilities, and third-party connections like Nodemailer or Puppeteer.

## Getting Started

Follow these simple steps to start using the template:

1. **Clone the Project**: Clone this repository to your local machine.

2. **Create Environment File**: Create a `.env.dev` file and add the variable `PORT` to specify the port for the development environment.

3. **Run Development Server**: Execute `pnpm run dev` to start the development server.

4. **Customization**: Modify routes, controllers, and models as per your project requirements.

## Usage

Once set up, you can begin developing your Node.js application with TypeScript using this starter template. Utilize the provided structure and tools to build robust and scalable solutions effortlessly.

Happy coding! 🚀