https://github.com/andre-ols/setup-node-typescript

https://github.com/andre-ols/setup-node-typescript

Last synced: 16 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/andre-ols/setup-node-typescript
• Owner: andre-ols
• License: mit
• Created: 2023-10-24T19:04:38.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-03T18:13:53.000Z (26 days ago)
• Last Synced: 2025-01-03T19:25:32.533Z (26 days ago)
• Language: TypeScript
• Size: 31.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Node.js TypeScript API with Docker

This is a sample project demonstrating a simple setup to build an API using Node.js, TypeScript, and Docker.

## Prerequisites

Ensure that you have Node.js (v18.13.0), Yarn (v1.22.19), and Docker (24.0.6) or higher installed on your machine.

### Node.js (v18.13.0) [Download](https://nodejs.org/en/download/)

### Yarn (v1.22.19) [Download](https://classic.yarnpkg.com/en/docs/install/#windows-stable)

### Docker (v24.0.6) [Download](https://docs.docker.com/get-docker/)

## Project Setup

1. Clone the repository.

```bash

   git clone https://github.com/andre-ols/setup-node-typescript.git

   cd setup-node-typescript

```

2. Install the dependencies.

```bash

   yarn install

```

## Running the Application

### Run in Development Mode

```bash

   yarn start:dev

```

This will start the Node.js server using TypeScript and Nodemon for automatic restarts during development.

### Run in Production Mode

```bash

   yarn start:prod

```

This will start the Node.js server using the compiled JavaScript code.

### Run with Docker in Development Mode

```bash

   yarn start:docker:dev

```

This will start the Node.js server using Docker and Nodemon for automatic restarts during development.

### Run with Docker in Production Mode

```bash

   yarn start:docker:prod

```

This will start the Node.js server using Docker and the compiled JavaScript code.

## Endpoints

### GET /

Returns: `Hello World!`

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.