"readME-entity-management"

README.md

@@ -1,3 +1,242 @@
-# elevate-entity-service
-Elevate entity service
-# entity-management
+<div align="center">
+
+# Entity Management
+
+<a href="https://shikshalokam.org/elevate/">
+<img
+    src="https://shikshalokam.org/wp-content/uploads/2021/06/elevate-logo.png"
+    height="140"
+    width="300"
+  />
+</a>
+
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/ELEVATE-Project/notification/tree/master.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/ELEVATE-Project/notification/tree/master)
+[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=ELEVATE-Project_notification&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=ELEVATE-Project_notification)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=ELEVATE-Project_notification&metric=coverage)](https://sonarcloud.io/summary/new_code?id=ELEVATE-Project_notification)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=ELEVATE-Project_notification&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=ELEVATE-Project_notification)
+[![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
+[![Docs](https://img.shields.io/badge/Docs-success-informational)](https://elevate-docs.shikshalokam.org/mentorEd/intro)
+[![Docs](https://img.shields.io/badge/API-docs-informational)](https://dev.elevate-apis.shikshalokam.org/notification/api-doc)
+![GitHub package.json version (subfolder of monorepo)](https://img.shields.io/github/package-json/v/ELEVATE-Project/notification?filename=src%2Fpackage.json)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+<details><summary>CircleCI insights</summary>
+
+[![CircleCI](https://dl.circleci.com/insights-snapshot/gh/ELEVATE-Project/notification/master/buil-and-test/badge.svg?window=30d)](https://app.circleci.com/insights/github/ELEVATE-Project/notification/workflows/buil-and-test/overview?branch=master&reporting-window=last-30-days&insights-snapshot=true)
+
+</details>
+<!-- <details><summary>dev</summary>
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/ELEVATE-Project/mentoring/tree/dev.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/ELEVATE-Project/mentoring/tree/dev)
+![GitHub package.json version (subfolder of monorepo)](https://img.shields.io/github/package-json/v/ELEVATE-Project/user/dev?filename=src%2Fpackage.json)
+[![CircleCI](https://dl.circleci.com/insights-snapshot/gh/ELEVATE-Project/mentoring/dev/buil-and-test/badge.svg?window=30d)](https://app.circleci.com/insights/github/ELEVATE-Project/mentoring/workflows/buil-and-test/overview?branch=integration-testing&reporting-window=last-30-days&insights-snapshot=true)
+[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=ELEVATE-Project_mentoring&metric=duplicated_lines_density&branch=dev)](https://sonarcloud.io/summary/new_code?id=ELEVATE-Project_mentoring)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=ELEVATE-Project_mentoring&metric=coverage&branch=dev)](https://sonarcloud.io/summary/new_code?id=ELEVATE-Project_mentoring)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=ELEVATE-Project_mentoring&metric=vulnerabilities&branch=revert-77-integration-test)](https://sonarcloud.io/summary/new_code?id=ELEVATE-Project_mentoring)
+</details> -->
+
+</br>
+This Service enables the creation and management of various entities and entityType .It
+    provides functionalities for entities, ensuring seamless integration and
+    maintenance of entity-related data across the platform.
+</div>
+
+<br>
+
+# System Requirements
+
+-   **Operating System:** Ubuntu 22
+-   **Node.js:** v20
+-   **mongoDb:** v4
+
+# Setup Options
+
+Elevate entity-management services can be setup in local using two methods:
+
+<details><summary>Dockerized service with local dependencies(Intermediate)</summary>
+
+## A. Dockerized Service With Local Dependencies
+
+**Expectation**: Run single docker containerized service with existing local (in host) or remote dependencies.
+
+### Local Dependencies Steps
+
+
+1.  **Download Docker Compose File:** Retrieve the **[docker-compose.yml](https://raw.githubusercontent.com/ELEVATE-Project/entity-management/refs/heads/develop/docker-compose.yml)** file from the entity-management service repository and save it to the entity-management directory.
+
+2. Run the docker container.
+
+    - For Mac & Windows with docker v18.03+:
+
+        ```
+        $ docker run --name entity-management shikshalokamqa/elevate-entity-management:1.0.0
+        ```
+
+    - For Linux:
+        ```
+        $ docker run --name entity-management --add-host=host.docker.internal:host-gateway shikshalokamqa/elevate-entity-management:1.0.0`
+        ```
+        Refer [this](https://stackoverflow.com/a/24326540) for more information.
+
+### Remote Dependencies Steps
+
+1. Run the docker container.
+
+    ```
+    $ docker run --name entity-management shikshalokamqa/elevate-entity-management:1.0.0
+    ```
+
+</details>
+
+<details><summary>Local Service with local dependencies(Hardest)</summary>
+
+## B. Local Service With Local Dependencies
+
+**Expectation**: Run single service with existing local dependencies in host (**Non-Docker Implementation**).
+
+## Installations
+
+### Install Node.js LTS
+
+Refer to the [NodeSource distributions installation scripts](https://github.com/nodesource/distributions#installation-scripts) for Node.js installation.
+
+```bash
+$ curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash - &&\
+sudo apt-get install -y nodejs
+```
+
+### Install PM2
+
+Refer to [How To Set Up a Node.js Application for Production on Ubuntu 22.04](https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-22-04).
+
+**Run the following command**
+
+```bash
+$ sudo npm install pm2@latest -g
+```
+
+## Setting up Repository
+
+### Clone the entity-management repository to /opt/backend directory
+
+```bash
+opt/backend$ git clone -b develop-2.5 --single-branch "https://github.com/ELEVATE-Project/entity-management"
+```
+
+### Install Npm packages from src directory
+
+```bash
+backend/entity-management/src$ sudo npm i
+```
+
+### Create .env file in src directory
+
+```bash
+entity-management/src$ sudo nano .env
+```
+
+Copy-paste the following env variables to the `.env` file:
+
+```env
+# entity-management Service Config
+
+# Port on which service runs
+APPLICATION_PORT=5001
+
+# Application environment
+APPLICATION_ENV=development
+
+# Route after the base URL
+APPLICATION_BASE_URL=/entity/
+
+# Api doc URL
+API_DOC_URL= "https://project-dev.elevate-apis.shikshalokam.org/entity-management/api-doc"
+
+#User service URL
+USER_SERVICE_URL = http://localhost:3001/user
+
+
+INTERNAL_ACCESS_TOKEN="internal_access_token"
+
+#DB URL
+MONGODB_URL=mongodb://mongo:27017/elevate-entity-management
+
+#service name
+SERVICE_NAME = elevate-entity-service
+
+version=8
+```
+
+Save and exit.
+
+## Setting up Databases
+
+**Start MongoDB Service**
+
+```bash
+sudo systemctl start mongod
+```
+
+**Verify MongoDB is running**
+
+```bash
+sudo systemctl status mongod
+
+```
+
+## Start the Service
+
+Navigate to the src folder of entity-management service and run pm2 start command:
+
+```bash
+entity-management/src$ pm2 start app.js -i 2 --name elevate-entity-management
+```
+
+#### Run pm2 ls command
+
+```bash
+$ pm2 ls
+```
+
+</details>
+
+<br>
+
+# Run tests
+
+## Integration tests
+
+```
+npm run test:integration
+```
+
+To know more about integration tests and their implementation refer to the project [Wiki](https://github.com/ELEVATE-Project/user/wiki/Integration-and-Unit-testing).
+
+## Unit tests
+
+```
+npm test
+```
+
+# Used in
+
+This project was built to be used with [Project Service](https://github.com/ELEVATE-Project/project-service) and [User Service](https://github.com/ELEVATE-Project/user.git).
+
+The frontend/mobile application [repo](https://github.com/ELEVATE-Project/observation-survey-projects-pwa).
+
+You can learn more about the full implementation of project-service [here](https://elevate-docs.shikshalokam.org/.project/intro) .
+
+# Team
+
+<a href="https://github.com/ELEVATE-Project/entity-management/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=ELEVATE-Project/entity-management" />
+</a>
+
+<br>
+
+# Open Source Dependencies
+
+Several open source dependencies that have aided Mentoring's development:
+
+![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
+![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white)
+![Git](https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white)

docker-compose.yml

@@ -1,46 +1,33 @@
 version: '3'
 services:
   mongo:
-    image: 'mongo:4.1.4'
-    container_name: mongo
+    image: 'mongo:4.4.14'
     restart: 'always'
-    command:
-      - '--logpath'
-      - '/var/log/mongodb/mongod.log'
     ports:
       - '27017:27017'
     networks:
-      - elevate_net
-    volumes:
-      - mongo-data:/data/db
-      - logs:/var/log/mongodb
-  redis:
-    image: 'redis:7.0.0'
-    container_name: redis
-    restart: 'always'
-    ports:
-      - '6379:6379'
-    networks:
-      - elevate_net
+      - entity_net
+    # volumes:
+    #   - mongo-data:/data/db
     logging:
       driver: none
-  entity-mangement:
-    build: './'
-    container_name: entity-management
-    volumes:
-      - ./src/:/var/src
+  entity_management:
+    image: shikshalokamqa/elevate-entity-management:1.0.0
     ports:
       - '5001:5001'
     command: ['nodemon', 'app.js']
     environment:
-      - MONGODB_URL=mongodb://mongo:27017/elevate-diksha
+      - MONGO_URL=mongo:27017
+    env_file:
+      - src/.env
     depends_on:
       - mongo
     networks:
-      - elevate_net
+      - entity_net
 
 networks:
-  elevate_net:
+  entity_net:
+    # external: false
 volumes:
   mongo-data:
   logs: