Installation Guide

Introduction

The ProCONF Admin Dashboard server is used to handle Admin-level functionality, like get/set configuration, get server statistics.

Software required

- NodeJs(v20.9.0)
- Npm(10.2.5)
- Mysql-client(5.7)
- nodemon (not mandatory)

Clone and Run Application

Clone the repository

git clone https://gitlab.springct.com/springct/proconf-admin.git

cd proconf-admin

Updated config.json for database connectivity

Open config.json and update it, file path src/config

Run the application locally

npm install

npm run start

The application will start in port 5000.

If you want to change the port then update port number in .env file.

Run the application locally for development (need nodemon package)

npm install

npm install -g nodemon (Install nodemon globally in your system)

npm run watch

Database Migration

There are three commands to create, migrate, and undo migrated database operations. These commands are defined in the script section of package.json file.

To create migration file

npm run migration:create ‘file_name’

To implement new migration

npm run migrate

To undo/rollback migration

npm run migration:rollback

To know more about sequelize and migrations click here.