Exlint

Exlint Dashboard

The dashboard for Exlint product, including both frontend and backend applications.

Installation

Install pnpm globally

npm i -g pnpm

Run locally with Docker

Clone the project

git clone git@github.com:Exlint/dashboard.git

Go to the project directory

cd dashboard

In order to run the database with docker please append your /etc/hosts with:

127.0.0.1 mongo_replica_1
127.0.0.1 mongo_replica_2
127.0.0.1 mongo_replica_3

Run the project cluster:

pnpm cluster:start

Push code

When pushing the code, you must follow the commit messages convention. First stage your desired changes and then run git cmt in the root folder. You should be prompted to a commit flow in the terminal, which helps you to write a commit message following the repository convention.

If git cmt exits with an error, make sure you run pnpm install before.

Update the database

When you want to configure the database with more indices, collections and such, you need to sync Prisma with MongoDB

pnpm prisma-push:dev

Stop the cluster

When you want to stop the cluster

pnpm cluster:stop

Restart the cluster

When you want to restart the cluster

pnpm cluster:restart

Clean the database

When you want to clean the database

pnpm db:clean

Backend documentation

When you want look at the backend documentation

cd ./apps/backend
pnpm compodoc

CLI backend documentation

When you want look at the cli-backend documentation

cd ./apps/cli-backend
pnpm compodoc

Backend OpenAPI

When you want look at the backend OpenAPI (Swagger), you need to run the cluster. Then, you can browse to http://localhost:3000/api (replace the port if you use other port)

CLI backend OpenAPI

When you want look at the CLI backend OpenAPI (Swagger), you need to run the application in development mode. Then, you can browse to http://localhost:4000/api (replace the port if you use other port)