Project Installation

I. Introduction

This document provides a step-by-step guide on how to install Qranty on your local machine. By following these instructions, you will be able to set up the necessary environment and deploy Qranty for testing and development purposes

II. Prerequisites

Before you begin the installation process, make sure you have the following prerequisites:

• Node.js installed on your machine Guide to install Node.js
• MongoDB installed and running Guide to install MongoDB
• Redis installed and running Guide to install Redis

III. Installation Steps

1. Clone the Repository

First, clone the Qranty repository from GitLab:

a. Clone server repository

• Using SSH:

git@gitlab.com:gcalls/rnd/qranty/server.git

• Using HTTPS:

https://gitlab.com/gcalls/rnd/qranty/server.git

b. Clone client repository

• Using SSH:

git@gitlab.com:gcalls/rnd/qranty/client.git

• Using HTTPS:

https://gitlab.com/gcalls/rnd/qranty/client.git

c. Clone admin repository

• Using SSH:

git@gitlab.com:gcalls/rnd/qranty/admin.git

• Using HTTPS:

https://gitlab.com/gcalls/rnd/qranty/admin.git

2. Install Dependencies

Navigate to the root directory of each repository (server, client, admin) and install the required dependencies using the following command:

npm install

3. Configure Environment Variables

Create a .env file in the root directory of each repository (server, client, admin) and add the necessary environment variables. You can refer to the .env.example file for the required variables.

4. Start the Application

Once you have cloned the repositories, installed the dependencies, and configured the environment variables, you can start the application by running the following command in each repository:

For the client and admin:

npm start

For the server:

npm run dev