Project Name

Node, Express, Typescript, Jest, Docker Hexagonal Architecture Template

Introduction

This is a template to run a node.js project that uses hexagonal architecture with docker

Installation and Usage

Using Docker

Clone the Repository

git clone git@github.com:andres-root/node-base-hex.git

Build with Docker Compose

Navigate to the project directory:
```
cd [Your Project Directory]
```
Build the project using Docker Compose:
```
docker compose build
```
Run the Project

Run your project in detached mode:
```
docker compose up -d
```

Running Tests

To run tests, follow these steps:

Install Dependencies
```
npm install
```
Run Tests
```
npm run test
```

Running Without Docker

To run the project without Docker, ensure the Docker backend instance is not running and that you are running a local PostgreSQL DB instance, then follow these steps:

Install Dependencies
```
npm install
```
Start the Development Server
```
npm run dev
```

andres-root/node-base-hex