https://github.com/mhp24/kassita-client-gateway

https://github.com/mhp24/kassita-client-gateway

Last synced: 18 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/mhp24/kassita-client-gateway
• Owner: MHP24
• Created: 2024-10-12T18:27:44.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-21T22:16:42.000Z (4 months ago)
• Last Synced: 2024-10-22T20:11:08.412Z (4 months ago)
• Language: TypeScript
• Size: 60.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
 ⭐ NestJS Template ⭐




  

    

  


  


    

    

    

  



## About this template 📕

This template includes a development setup and environment multi OS support ready-to-use outside the box, and has the config ready for:



  
ESLint

  
Prettier integration

  
Docker hot reload feature (Windows supported)

  
Husky integration

  
Commit lint (Conventional commits standard)

  
Joi .env validation schema



## Setup and installation 🚀 

Before using this template, ensure you have [Node.js](https://nodejs.org/en) installed (version 20.12.0 for this template) and [Docker](https://www.docker.com/) installed and running.

### Steps

 1 . Install dependencies using [yarn](https://yarnpkg.com/) as package manager:

```bash

  yarn

```

 2 . Replace .env.template variables and rename it as __.env file__

#### __Environment variables specification__  

|   |   |   |

|---|---|---|

|Variable|Type|Description|

|PORT | Integer (positive) | Port where app runs |



 

 3 . __Development mode using Docker:__ Run Docker compose file in the branch directory:

```bash

  docker-compose -f docker-compose.dev.yml up --build

```


 4 . __Development mode without Docker:__ Start the development server:

```bash

  yarn start:dev

```