https://github.com/rathoretaruncodes/ts-nodemon-starter

Nodemon-powered Typescript Express boilerplate
https://github.com/rathoretaruncodes/ts-nodemon-starter

boilerplate-template expressjs nodemon starter-kit typescript

Last synced: about 2 months ago
JSON representation

Nodemon-powered Typescript Express boilerplate

• Host: GitHub
• URL: https://github.com/rathoretaruncodes/ts-nodemon-starter
• Owner: rathoretaruncodes
• License: mit
• Created: 2024-09-07T21:14:40.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-08T16:09:16.000Z (4 months ago)
• Last Synced: 2024-09-08T22:34:04.060Z (4 months ago)
• Topics: boilerplate-template, expressjs, nodemon, starter-kit, typescript
• Language: TypeScript
• Homepage:
• Size: 40 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ts-nodemon-starter

A TypeScript starter template with Nodemon for automatic reloading and Express.js.

## Features

- **TypeScript**: Type-safe JavaScript with static type checking.

- **Nodemon**: Automatic server reloading during development.

- **Express.js**: Minimal and flexible Node.js web application framework.

- **dotenv**: Environment variable management.

## Getting Started

### Prerequisites

Ensure you have the following installed:

- [Node.js](https://nodejs.org/)

- [Yarn](https://yarnpkg.com/) or [npm](https://www.npmjs.com/) (for package management)

### Installation

To use `ts-nodemon-starter` in your project, follow these steps:

1. **Clone the repository**

   ```bash

   git clone https://github.com/rathoretaruncodes/ts-nodemon-starter.git

   cd ts-nodemon-starter

2. **Install Dependencies**

   ```bash

   npm install

2. **Setup a `.env` File**

   Create a `.env` file in the root directory by copying `.env.example`:

   ```bash

   cp .env.example .env

### Usage

1. **Development**

   Start the development server with automatic reloading:

   ```bash

   npm run dev

2. **Build**

   Compile TypeScript files to JavaScript:

   ```bash

   npm run build

3. **Start**

   Run the compiled application:

   ```bash

   npm start

## Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.

2. Create a new branch for your feature or fix.

3. Make your changes and ensure they are well tested.

4. Open a pull request with a clear description of your changes.

## License

This project is licensed under the [MIT](https://github.com/rathoretaruncodes/ts-nodemon-starter/blob/main/LICENSE) license.

## Contact

For any questions or feedback, please open an issue in the [repository](https://github.com/rathoretaruncodes/ts-nodemon-starter).