Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
d1793dd
Add SQL scripts for creating distributed tables and environment confi…
priyanka-TL Nov 26, 2025
c4bccbc
Merge branch 'setupGuide-3.4' of https://github.com/ELEVATE-Project/p…
priyanka-TL Nov 26, 2025
96fbaac
Add integrated deployment setup for Projects Service with Self Creati…
priyanka-TL Nov 26, 2025
141c7d5
Add README for Dockerized setup of Projects Service on Ubuntu
priyanka-TL Nov 26, 2025
f4d1a0f
Add setup scripts and sample data for Dockerized Projects Service
priyanka-TL Nov 26, 2025
63f19ab
Add Docker Compose file and update setup script for SCP deployment
priyanka-TL Nov 26, 2025
2b8ac67
updated the citus scp
priyanka-TL Nov 26, 2025
2beb5ca
Update README.md to enhance clarity and structure
priyanka-TL Nov 27, 2025
8344e24
Merge branch 'setupGuide-3.4' of https://github.com/ELEVATE-Project/p…
priyanka-TL Nov 27, 2025
4554df8
added scp env
priyanka-TL Nov 27, 2025
b1a9238
Update setup_project.sh to create survey-project-creation directory a…
priyanka-TL Nov 27, 2025
5742ebc
Add cloning of survey-project-creation-service repository in setup_pr…
priyanka-TL Nov 27, 2025
fdc86e4
Update README.md to include port 27017 in the availability check
priyanka-TL Nov 27, 2025
99511b3
Fix command syntax in user service startup script in docker-compose
priyanka-TL Nov 27, 2025
a916a1b
Enhance Kafka readiness check in survey-project-creation service star…
priyanka-TL Nov 27, 2025
40b86ab
Add environment variables and volume for survey-project-creation-serv…
priyanka-TL Nov 27, 2025
e788376
Add environment configuration files and setup scripts for ELEVATE-Pro…
priyanka-TL Dec 2, 2025
8bd8893
Merge branch 'setupGuide-3.4' of https://github.com/ELEVATE-Project/p…
priyanka-TL Dec 2, 2025
c6b4bc1
Add sample data insertion script and update README for survey project…
priyanka-TL Dec 2, 2025
4eddd5e
Update README with new script URLs for setupGuideSCP
priyanka-TL Dec 2, 2025
05c09a2
Update environment configuration for local development and adjust REA…
priyanka-TL Dec 2, 2025
8490d59
Add new configFile.json and update README for project service setup
priyanka-TL Dec 2, 2025
9be4543
Update database creation script and enhance README with cloud environ…
priyanka-TL Dec 2, 2025
75cba7d
Add mentoring service URL to user environment and update README for s…
priyanka-TL Dec 2, 2025
129af6e
Update README with instructions for uploading certificate templates a…
priyanka-TL Dec 2, 2025
fe90213
Fix directory navigation in README for uploading certificate template…
priyanka-TL Dec 2, 2025
d07d654
Fix command sequence in README for running service scripts
priyanka-TL Dec 2, 2025
43b796e
Update environment configurations to standardize MongoDB URLs and enh…
priyanka-TL Dec 4, 2025
3b0e1b1
Add scripts for importing forms and inserting sample solutions, and u…
priyanka-TL Dec 4, 2025
3378f66
Refactor code structure for improved readability and maintainability
priyanka-TL Dec 4, 2025
4d18a43
Add script for inserting sample data into entity and project databases
priyanka-TL Dec 4, 2025
09f9473
Fix project database name in sample data script
priyanka-TL Dec 4, 2025
ce09201
Update import forms script URL in README for setup guide
priyanka-TL Dec 4, 2025
1acefad
Update README to include axios installation step before running impor…
priyanka-TL Dec 4, 2025
7a6811b
Fix formatting for axios installation instructions in README
priyanka-TL Dec 4, 2025
ca69fe2
Update README to correct URL for sample data insertion script and add…
priyanka-TL Dec 4, 2025
7746af3
Enhance insert_sample_data.sh to ensure sequences are up-to-date and …
priyanka-TL Dec 4, 2025
fad0ac5
Add user roles for content creation and program management workflows
priyanka-TL Dec 6, 2025
fbbc297
Update INTERNAL_ACCESS_TOKEN in notification_env for consistency
priyanka-TL Dec 6, 2025
8562d0b
Format example command for creating ELEVATE-Project directory in README
priyanka-TL Dec 6, 2025
c639256
Add additional user entries and update sequences in insert_sample_dat…
priyanka-TL Dec 6, 2025
9b663c6
Refactor insert_sample_data.sh to add new user roles for content crea…
priyanka-TL Dec 6, 2025
ecc88d7
Refactor setup_project.sh and update sample data scripts
priyanka-TL Dec 6, 2025
614b602
Format example command for creating project directory in README
priyanka-TL Dec 6, 2025
19d95a8
Refactor environment files and update download links in setup_project.sh
priyanka-TL Dec 6, 2025
6b2934c
Enhance docker-compose configuration with health checks for Zookeeper…
priyanka-TL Dec 6, 2025
e88babd
Update baseURL in env.js and correct download links in setup_project.…
priyanka-TL Dec 6, 2025
29284eb
Update volume path for env.js in docker-compose configuration
priyanka-TL Dec 6, 2025
e15d5d8
Update docker-compose configuration for scp service and add ORG_CODE_…
priyanka-TL Dec 6, 2025
9e04e8b
Update Kafka group IDs and notification topics in environment files; …
priyanka-TL Dec 7, 2025
b5f747b
Add node_modules volume to survey project creation service in docker-…
priyanka-TL Dec 7, 2025
e0ada18
Add config.json creation logic and update user_env with new header names
priyanka-TL Dec 7, 2025
ff40395
Refactor docker-compose for Zookeeper and Kafka services: update envi…
priyanka-TL Dec 7, 2025
38c58b4
Fix config file naming in project service: update script to reference…
priyanka-TL Dec 7, 2025
0a9d504
Update Kafka URL in environment variables to use the correct port 9092
priyanka-TL Dec 7, 2025
ab7a557
Add new user roles and sample users, update tenant metadata, and ensu…
priyanka-TL Dec 7, 2025
6e02c96
Update README.md: Un-comment section for Sample Data Creation for Pro…
priyanka-TL Dec 7, 2025
5d90297
Update macOS setup guide link and add platform specification for Citu…
priyanka-TL Dec 8, 2025
bb66b9d
Fix installation instructions in README.md for Mac users
priyanka-TL Dec 8, 2025
2df1492
Merge branch 'setupGuide-3.4' of https://github.com/ELEVATE-Project/p…
priyanka-TL Dec 8, 2025
64e8a3a
Update Docker Compose and setup script: switch to pre-release image a…
priyanka-TL Dec 8, 2025
dd91392
Make insert_sample_data.sh executable after downloading
priyanka-TL Dec 8, 2025
c01261d
Add container names for Redis, Entity Management, User, Notification,…
priyanka-TL Dec 8, 2025
566909f
Update Docker Compose for SCP service: switch to pre-release image an…
priyanka-TL Dec 8, 2025
303d6fa
Add sample data SQL scripts for Mac/Linux and Windows environments; e…
priyanka-TL Apr 6, 2026
ddcd75d
Merge branch 'new-setupGuide-3.4' of https://github.com/ELEVATE-Proje…
priyanka-TL Apr 6, 2026
cca793e
Update setup_project.sh to use main branch for file downloads and rem…
priyanka-TL Apr 6, 2026
8aa8b6a
Merge branch 'main' of https://github.com/ELEVATE-Project/project-ser…
priyanka-TL Apr 6, 2026
84e4b94
mac doc
priyanka-TL May 19, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
141 changes: 107 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ The Project building block facilitates the creation and engagement with micro-im

## 💻 Supported Operating Systems

- **Ubuntu** (Recommended: Version 20 and above)
- **Windows** (Recommended: Version 11 and above)
- **macOS** (Recommended: Version 12 and above)
- **Ubuntu** (Recommended: Version 20 and above)
- **Windows** (Recommended: Version 11 and above)
- **macOS** (Recommended: Version 12 and above)

---

Expand All @@ -40,24 +40,23 @@ This section outlines the different ways to set up the **Projects Service**. Ple

This setup is ideal for **local development and testing**, where only the core Projects Service components are required.

In the **Stand-Alone Setup**, the **Samiksha service is not included**. This mode supports the complete lifecycle of **program creation and program consumption**, along with **project creation and project consumption**. Users can also **view and generate reports** based on the configured programs and projects.
In the **Stand-Alone Setup**, the **Samiksha service is not included**. This mode supports the complete lifecycle of **program creation and program consumption**, along with **project creation and project consumption**. Users can also **view and generate reports** based on the configured programs and projects.

This setup is recommended when survey and observation features powered by Samiksha are not required, and the focus is limited to core program and project management workflows.


#### I. Docker Setup (Recommended)

- [Setup guide for Linux](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/docker/stand-alone/ubuntu/README.md)
- [Setup guide for macOS](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/docker/stand-alone/mac-os/README.md)
- [Setup guide for Windows](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/docker/stand-alone/windows/README.md)
- [Setup guide for Linux](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/docker/stand-alone/ubuntu/README.md)
- [Setup guide for macOS](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/docker/stand-alone/mac-os/README.md)
- [Setup guide for Windows](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/docker/stand-alone/windows/README.md)

<br>

#### II. Native Setup (PM2 Managed Services)

- [Setup guide for Linux](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/native/stand-alone/ubuntu/README.md)
- [Setup guide for macOS](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/docker/stand-alone/mac-os/README.md)
- [Setup guide for Windows](link/to/standalone/native/windows/README)
- [Setup guide for Linux](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/native/stand-alone/ubuntu/README.md)
- [Setup guide for macOS](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/docker/stand-alone/mac-os/README.md)
- [Setup guide for Windows](link/to/standalone/native/windows/README)

Comment on lines +57 to 60
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix incorrect Native setup links in Stand-Alone section.

Line 58 points to the Docker macOS guide (not Native), and Line 59 is a placeholder URL. These links currently misroute users.

Suggested patch
- -   [Setup guide for macOS](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/docker/stand-alone/mac-os/README.md)
- -   [Setup guide for Windows](link/to/standalone/native/windows/README)
+ -   [Setup guide for macOS](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/native/stand-alone/mac-os/README.md)
+ -   [Setup guide for Windows](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/native/stand-alone/windows/README.md)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 57 - 60, The two Stand-Alone "Native" links are
incorrect: the "Setup guide for macOS" currently points to the Docker macOS
guide and the "Setup guide for Windows" is a placeholder; update the link
targets in README.md so the "Setup guide for macOS" anchor (the line labeled
"Setup guide for macOS") uses the native/mac-os native setup URL (replace the
Docker path with the native/mac-os README for stand-alone) and replace the
"Setup guide for Windows" placeholder URL (the line labeled "Setup guide for
Windows") with the correct native/windows stand-alone README URL; ensure the
anchor texts remain the same and only the hrefs are corrected.

</details>

Expand All @@ -69,29 +68,101 @@ This setup is recommended when survey and observation features powered by Samiks

This setup integrates the Projects Service with the **Samiksha Service**, providing a full-featured, production-ready deployment environment.

In this **Integrated Setup**, the system supports the complete lifecycle of **program creation and program consumption**, along with **project creation and project consumption**. It also enables **survey creation, survey consumption, observation creation, and observation consumption**, allowing structured assessments and evaluations to be conducted.
In this **Integrated Setup**, the system supports the complete lifecycle of **program creation and program consumption**, along with **project creation and project consumption**. It also enables **survey creation, survey consumption, observation creation, and observation consumption**, allowing structured assessments and evaluations to be conducted.

Users can further **view and generate reports** across programs, projects, surveys, and observations, making this setup suitable for end-to-end project execution and assessment workflows in real-world deployments.

#### I. Docker Setup (Recommended)

- [Setup guide for Linux](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/docker/project-with-survey/ubuntu/README.md)
- [Setup guide for macOS](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/docker/project-with-survey/mac-os/README.md)
- [Setup guide for Windows](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/docker/project-with-survey/windows/README.md)
- [Setup guide for Linux](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/docker/project-with-survey/ubuntu/README.md)
- [Setup guide for macOS](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/docker/project-with-survey/mac-os/README.md)
- [Setup guide for Windows](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/docker/project-with-survey/windows/README.md)

<br>

#### II. Native Setup (PM2 Managed Services)

- [Setup guide for Linux](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/native/project-with-survey/ubuntu/README.md)
- [Setup guide for macOS](link/to/samiksha/native/macos/README)
- [Setup guide for Windows](link/to/samiksha/native/windows/README)
- [Setup guide for Linux](https://github.com/ELEVATE-Project/project-service/blob/main/documentation/3.4.0/setup/native/project-with-survey/ubuntu/README.md)
- [Setup guide for macOS](link/to/samiksha/native/macos/README)
- [Setup guide for Windows](link/to/samiksha/native/windows/README)
Comment on lines +86 to +87
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Replace placeholder links with real targets before merge.

These placeholder URLs are dead links in published documentation and block setup navigation.

Also applies to: 117-117, 139-139

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 86 - 87, Replace the placeholder links in README.md
for the "Setup guide for macOS" and "Setup guide for Windows" bullets (and the
other occurrences noted at lines 117 and 139) with the real target URLs or
relative paths to the actual native/macos/README and native/windows/README
files; update the link targets so they point to valid documentation pages in the
repo or published docs, ensuring the link text "Setup guide for macOS" and
"Setup guide for Windows" resolve to working URLs before merging.


</details>
<br>

### 🚀 **WITH SELF CREATION PORTAL (SCP) (Integrated Deployment)**

<details>
<summary> **Click to Expand Integrated Setup Options** </summary>
<br>

This setup integrates the Projects Service and Samiksha Service with the **Self Creation Portal**, providing a full-featured, production-ready deployment environment.

#### I. Docker Setup (Recommended)

<details>
<summary> 1. Ubuntu Setup </summary>
<br>
Go to the detailed Ubuntu Docker setup guide: **<a href="https://github.com/ELEVATE-Project/project-service/blob/setupGuideSCP/documentation/3.4.0/setup/docker/scp/ubuntu/README.md" target="_blank">SETUP_SCP_DOCKER_UBUNTU.md</a>**
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Avoid linking root README to a feature branch.

These links target blob/setupGuideSCP/...; once that branch is deleted/renamed, docs break. Root README should point to stable main (or relative paths).

Also applies to: 111-111, 127-127, 133-133

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 105, The README currently links to a feature-branch URL
containing "blob/setupGuideSCP" (e.g. the link text
"SETUP_SCP_DOCKER_UBUNTU.md"); update those links to point to a stable location
by replacing the branch-specific path with the main branch (use "blob/main/...")
or use relative repository paths so they remain valid when feature branches are
removed; apply the same change for the other similar links flagged in the review
(lines referencing the setup guide URLs).

</details>

<details>
<summary> 2. macOS Setup </summary>
<br>
Go to the detailed macOS Docker setup guide: **<a href="https://github.com/ELEVATE-Project/project-service/blob/setupGuideSCP/documentation/3.4.0/setup/docker/scp/mac/README.md" target="_blank">SETUP_SCP_DOCKER_MACOS.md</a>**
</details>

<details>
<summary> 3. Windows Setup </summary>
<br>
Go to the detailed Windows Docker setup guide: **<a href="link/to/scp/docker/windows/README" target="_blank">SETUP_SCP_DOCKER_WINDOWS.md</a>**
</details>

<br>

#### II. Native Setup (PM2 Managed Services)

<details>
<summary> 1. Ubuntu Setup </summary>
<br>
Go to the detailed Ubuntu Native setup guide: **<a href="https://github.com/ELEVATE-Project/project-service/blob/setupGuideSCP/documentation/3.4.0/setup/native/scp/ubuntu/README.md" target="_blank">SETUP_SCP_NATIVE_UBUNTU.md</a>**
</details>

<details>
<summary> 2. macOS Setup </summary>
<br>
Go to the detailed macOS Native setup guide: **<a href="https://github.com/ELEVATE-Project/project-service/blob/setupGuideSCP/documentation/3.4.0/setup/native/scp/mac/README.md" target="_blank">SETUP_SCP_NATIVE_MACOS.md</a>**
</details>

<details>
<summary> 3. Windows Setup </summary>
<br>
Go to the detailed Windows Native setup guide: **<a href="link/to/samiksha/native/windows/README" target="_blank">SETUP_SCP_NATIVE_WINDOWS.md</a>**
</details>

</details>

---

## 📖 Related Documentation & Tools

### Versioning & Documentation Links

This README is focused on the **3.4.0 Setup Guide** for the Projects Service.

- **Current Version (3.4.0) Documentation:** All setup links above point to the **3.4.0** guides.
- **Legacy Version (1.0.0) Documentation:** Access the documentation for the previous major release here: **<a href="https://github.com/ELEVATE-Project/project-service/blob/setupGuide-3.4/documentation/1.0.0/ReadMe.md" target="_blank">View 1.0.0 Documentation</a>**

### Postman Collections

- **<a href="https://github.com/ELEVATE-Project/project-service/tree/main/api-doc" target="_blank">Projects Service API Collection</a>**

### Adding New Projects to the System

With implementation scripts, you can seamlessly add new projects to the system. Once a project is successfully added, it becomes visible on the portal, ready for use and interaction. For a comprehensive guide on setting up and using the implementation script, please refer to the **<a href="https://github.com/ELEVATE-Project/project-service/tree/main/Project-Service-implementation-Script" target="_blank">documentation here</a>**.

---

## 📖 Related Documentation & Tools
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Remove duplicate top-level section heading.

## 📖 Related Documentation & Tools appears twice, causing duplicated TOC/navigation entries and markdownlint MD024 noise.

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 165-165: Multiple headings with the same content

(MD024, no-duplicate-heading)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 165, Remove the duplicate top-level section heading "## 📖
Related Documentation & Tools" so it only appears once in the README; locate
both occurrences of that exact heading text and delete the redundant one (ensure
you keep the instance that contains the relevant links/content and remove the
empty or duplicate header to stop duplicate TOC/navigation entries and
markdownlint MD024 warnings).


### 🗂️ Database Architecture Diagrams

Expand Down Expand Up @@ -131,11 +202,11 @@ Click on a service name to expand and view the diagram.

### 🧪 Postman Collections and API DOC

- <a href="https://github.com/ELEVATE-Project/project-service/tree/main/api-doc" target="_blank">
Projects Service API Collection
- <a href="https://github.com/ELEVATE-Project/samiksha-service/tree/main/api-doc" target="_blank">
Samiksha Service API Collection
</a>
- <a href="https://github.com/ELEVATE-Project/project-service/tree/main/api-doc" target="_blank">
Projects Service API Collection
- <a href="https://github.com/ELEVATE-Project/samiksha-service/tree/main/api-doc" target="_blank">
Samiksha Service API Collection
</a>
Comment on lines +205 to +209
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix malformed HTML list items in link sections.

The anchor/list markup is not properly closed per item, which can render incorrectly in GitHub markdown. Prefer pure markdown list links or fully closed <a> tags per bullet.

Suggested patch (markdown style)
- -   <a href="https://github.com/ELEVATE-Project/project-service/tree/main/api-doc" target="_blank">
-     Projects Service API Collection
- -   <a href="https://github.com/ELEVATE-Project/samiksha-service/tree/main/api-doc" target="_blank">
-       Samiksha Service API Collection
-     </a>
+ -   [Projects Service API Collection](https://github.com/ELEVATE-Project/project-service/tree/main/api-doc)
+ -   [Samiksha Service API Collection](https://github.com/ELEVATE-Project/samiksha-service/tree/main/api-doc)
- -   <a href="https://github.com/ELEVATE-Project/project-service/tree/main/Project-Service-implementation-Script" target="_blank">
-     solution-Upload-Portal-Service
- -   <a href="https://github.com/ELEVATE-Project/project-service/tree/main/Project-Service-implementation-Script" target="_blank">
-       solution-Upload-Portal
-     </a>
+ -   [solution-Upload-Portal-Service](https://github.com/ELEVATE-Project/project-service/tree/main/Project-Service-implementation-Script)
+ -   [solution-Upload-Portal](https://github.com/ELEVATE-Project/project-service/tree/main/Project-Service-implementation-Script)

Also applies to: 220-224

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 205 - 209, Fix the malformed HTML anchor list items
in README.md by converting each broken mixed HTML list entry into a proper
Markdown list link: replace the incomplete/open <a> tags around the "Projects
Service API Collection" and "Samiksha Service API Collection" entries with
fully-formed Markdown entries (e.g., "- [Projects Service API
Collection](https://github.com/ELEVATE-Project/project-service/tree/main/api-doc)")
and do the same for the other affected block (the entries referenced at lines
220-224) so every bullet is a single, valid Markdown link; update the text for
exact string matches "Projects Service API Collection" and "Samiksha Service API
Collection" (and the other listed items) to ensure anchors are closed and render
correctly.


---

Expand All @@ -146,27 +217,28 @@ Once it's successfully added, it becomes visible on the portal, ready for use an

For a comprehensive guide on setting up and using the SUP, please refer to:

- <a href="https://github.com/ELEVATE-Project/project-service/tree/main/Project-Service-implementation-Script" target="_blank">
solution-Upload-Portal-Service
- <a href="https://github.com/ELEVATE-Project/project-service/tree/main/Project-Service-implementation-Script" target="_blank">
solution-Upload-Portal
</a>
- <a href="https://github.com/ELEVATE-Project/project-service/tree/main/Project-Service-implementation-Script" target="_blank">
solution-Upload-Portal-Service
- <a href="https://github.com/ELEVATE-Project/project-service/tree/main/Project-Service-implementation-Script" target="_blank">
solution-Upload-Portal
</a>

---

### 🔖 Versioning & Documentation Links

This README is focused on the **3.4.0 Setup Guide** for the Projects Service.

- **Current Version (3.4.0) Documentation**
All setup links above point to the **3.4.0** guides.
- **Current Version (3.4.0) Documentation**
All setup links above point to the **3.4.0** guides.

- **Legacy Version (1.0.0) Documentation**
<a href="https://github.com/ELEVATE-Project/project-service/blob/main/documentation/1.0.0/ReadMe.md" target="_blank">
- **Legacy Version (1.0.0) Documentation**
<a href="https://github.com/ELEVATE-Project/project-service/blob/main/documentation/1.0.0/ReadMe.md" target="_blank">
View 1.0.0 Documentation
</a>
</a>

---

## 👥 Team

<a href="https://github.com/ELEVATE-Project/project-service/graphs/contributors">
Expand All @@ -176,6 +248,7 @@ This README is focused on the **3.4.0 Setup Guide** for the Projects Service.
---

### Open Source Dependencies

This project uses several open-source tools and dependencies that supported its development

![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
Expand All @@ -184,4 +257,4 @@ This project uses several open-source tools and dependencies that supported its
![Git](https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white)
![MongoDB](https://img.shields.io/badge/MongoDB-4EA94B?style=for-the-badge&logo=mongodb&logoColor=white)
![PostgreSQL](https://img.shields.io/badge/PostgreSQL-316192?style=for-the-badge&logo=postgresql&logoColor=white)
![RabbitMQ](https://img.shields.io/badge/RabbitMQ-FF6600?style=for-the-badge&logo=rabbitmq&logoColor=white)
![RabbitMQ](https://img.shields.io/badge/RabbitMQ-FF6600?style=for-the-badge&logo=rabbitmq&logoColor=white)
Original file line number Diff line number Diff line change
Expand Up @@ -287,4 +287,4 @@ let entities = [
module.exports = {
entities,
entityType,
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ const { MongoClient } = require('mongodb')
const url = 'mongodb://localhost:27017/' // MongoDB URL
const projectDB = 'elevate-project'
const entityDB = 'elevate-entity'
const samikshaDB = "elevate-samiksha";
const samikshaDB = 'elevate-samiksha'
const entityData = require('./entity_sampleData.js')
const projectData = require('./project_sampleData.js')
const surveyData = require("./survey_sampleData.js");
const surveyData = require('./survey_sampleData.js')

// MongoDB Error Code for Duplicate Key
const DUPLICATE_KEY_ERROR_CODE = 11000
Expand Down Expand Up @@ -116,7 +116,6 @@ async function insertData(collectionName, dataFile, currentDB = projectDB) {
}
}


async function main({ dataToBeInserted }) {
const collectionsToInsert = [
{ name: 'entities', data: dataToBeInserted.entities, db: entityDB },
Expand All @@ -130,20 +129,21 @@ async function main({ dataToBeInserted }) {
{ name: 'projectCategories', data: dataToBeInserted.projectCategoriesData, db: projectDB },
{ name: 'configurations', data: dataToBeInserted.configurationData, db: projectDB },
{ name: 'organizationExtension', data: dataToBeInserted.organizationExtensionData, db: projectDB },
{ name: "solutions", data: dataToBeInserted.solutionData, db:samikshaDB},
{ name: "criteria", data:dataToBeInserted.criteriaData, db : samikshaDB},
{ name: "criteriaQuestions", data: dataToBeInserted.criteriaQuestionsData, db : samikshaDB},
{ name: "frameworks", data: dataToBeInserted.frameworkData, db : samikshaDB},
{ name: "questions", data: dataToBeInserted.questionsData, db : samikshaDB},
{ name: "observations", data: dataToBeInserted.observationData, db : samikshaDB},
{ name: "surveys", data: dataToBeInserted.surveyData, db : samikshaDB},
{ name: "organizationExtension", data: dataToBeInserted.organizationExtensionData, db : samikshaDB},

{ name: 'solutions', data: dataToBeInserted.solutionData, db: samikshaDB },
{ name: 'criteria', data: dataToBeInserted.criteriaData, db: samikshaDB },
{ name: 'criteriaQuestions', data: dataToBeInserted.criteriaQuestionsData, db: samikshaDB },
{ name: 'frameworks', data: dataToBeInserted.frameworkData, db: samikshaDB },
{ name: 'questions', data: dataToBeInserted.questionsData, db: samikshaDB },
{ name: 'observations', data: dataToBeInserted.observationData, db: samikshaDB },
{ name: 'surveys', data: dataToBeInserted.surveyData, db: samikshaDB },
{ name: 'organizationExtension', data: dataToBeInserted.organizationExtensionData, db: samikshaDB },
]

console.log(`\n=================================================`)
console.log(
`🗑️ Starting CLEANUP for ${dataToBeInserted === entityData ? 'Entity Data' : 'Project Data & Survey Data' } Collections...`
`🗑️ Starting CLEANUP for ${
dataToBeInserted === entityData ? 'Entity Data' : 'Project Data & Survey Data'
} Collections...`
)
console.log(`=================================================`)

Expand All @@ -155,7 +155,9 @@ async function main({ dataToBeInserted }) {

console.log(`\n=================================================`)
console.log(
`➕ Starting INSERTION for ${dataToBeInserted === entityData ? 'Entity Data' : 'Project Data & Survey Data '} Collections...`
`➕ Starting INSERTION for ${
dataToBeInserted === entityData ? 'Entity Data' : 'Project Data & Survey Data '
} Collections...`
)
console.log(`=================================================`)

Expand All @@ -182,11 +184,10 @@ main({ dataToBeInserted: projectData })
})
.catch(console.error)


main({ dataToBeInserted: surveyData })
.then(() => {
console.log('\n=======================================')
console.log('✅ survey data population process finished.')
console.log('=======================================')
})
.catch(console.error)
.then(() => {
console.log('\n=======================================')
console.log('✅ survey data population process finished.')
console.log('=======================================')
})
.catch(console.error)
Loading