QELOS Installation and Setup Guide #

Prerequisites #

Before you start, ensure you have the following software installed on your system:

• Node.js v20+: The JavaScript runtime environment required to run QELOS.

• Docker: A platform for developing, shipping, and running applications in containers.

• Code Editor: A code editor is needed for development. We recommend Visual Studio Code, but you may use any editor or IDE of your choice.

• MongoDB GUI: A graphical tool for managing MongoDB databases. Popular options include Studio 3T and MongoDB Compass, but you can choose any MongoDB GUI tool or use MongoDB Atlas.

Recommended Software for Daily work #

Node.js v20+

The JavaScript runtime environment needed to run QELOS.

Docker

A platform for developing, shipping, and running applications in containers.

VS Code

A versatile code editor for development and debugging.

MongoDB Compass

A GUI for managing MongoDB databases. You can use MongoDB Compass or any other GUI of your choice.

Installation Steps #

Follow these steps to set up QELOS on your local machine:

1. Clone the Repository #

Download the QELOS repository from GitLab and navigate into the project directory:

git clone https://gitlab.com/qelos/qelos

2. Install Dependencies to the root directory of the project: #

Install the necessary npm packages:

npm install

3. Build the Project #

Compile the project with the build command:

npm run build

4. Start the Development Server #

Run the development server to start the application:

npm run dev

5. Populate the Database with Initial Data #

npm run populate-db

6. Access the Application #

Open your web browser and navigate to:

http://localhost:3000/

7. Use the following credentials to log in: #