70 lines (44 loc) · 1.61 KB

DENIM Visualizing

Installation

Prerequisites

NodeJS:

Install NodeJS.

Docker:

Linux: Install Docker Engine or Install Docker Desktop.
Windows: Install Docker Desktop.
MacOS: Install Docker Desktop.

Launching

You have the tree following options.

Launching from Docker Hub (preferred)

Docker Hub repository

Launching from source code

Open the project in an IDE and install the dependencies.
```
npm install
```
Generate the Swagger documentation.
```
npm run swagger
```
Launch the application.
```
npm run start
```

The app runs at http://localhost:3000.

Launching from source code with Docker

Open the project in an IDE and install the dependencies.
```
npm install
```
Generate the Swagger documentation.
```
npm run swagger
```

The project contains a Dockerfile at its root in order to create an image of the application.

A docker-compose.yml file also exists at the root in order to launch easily a container for the application.

Build the image and launch the container.
```
docker-compose up
```

⚠️ This command must be executed at the location of the docker-compose.yml file and have to be run as with the right privileges (administrator).