Kuunika - Product Master

[TOC]

Background

....

Installation on Local Machine

Dependencies

• NodeJS > v10.15.0

Setup

This project uses NestJs v7.0.0, click the following link to thier respective documentation for more information on NestJs.

Installation

Step 1: Clone Repo

Clone this repository into your local directory, Use the command below:

# Clone project to local machine
git clone https://github.com/Kuunika/Product-Master.git
# Navigation into directory
cd Product-Master

Step 2: Install Dependencies

In the root directory of the project run the following command

#Installing all dependencies
npm install

Step 3: Edit .env File

In the root directory there exist a file named '.env.example' create a copy of this file, rename the copy to '.env' and open it to edit the contents.

OCL_BASE_URL= # Add the URL to Your OCL API Org Repository
OCL_MASTER_REPO= # Add source that maps to all other desired systems
OCL_API_TOKEN= # Add your OCL API Key

Step 4: Run Test

npm run test:e2e

Step 5: Running Application

npm run start

Docker Installation

Step 1: Clone Repo

Clone this repository into your local directory, Use the command below:

# Clone project to local machine
git clone https://github.com/Kuunika/Product-Master.git
# Navigation into directory
cd Product-Master

Step 2: Install Dependencies

In the root directory of the project run the following command

#Installing all dependencies
npm install

Step 3: Edit .env File

In the root directory there exist a file named '.env.example' create a copy of this file, rename the copy to '.env' and open it to edit the contents.

OCL_BASE_URL= # Add the URL to Your OCL API Org Repository
OCL_MASTER_REPO= # Add source that maps to all other desired systems
OCL_API_TOKEN= # Add your OCL API Key

Step 4: Run Test

npm run test:e2e

Step 5: Create Dist Build for Project

npm run build

Step 6: Build Docker Images

docker image build -t product-master .

Step 7: Creating Docker Container

From withing the same directory run the following command.

docker run -d -p 3000:3000 --env-file ./.env product-master