-
Notifications
You must be signed in to change notification settings - Fork 24
New setup guide scp #735
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
New setup guide scp #735
Changes from all commits
d1793dd
c4bccbc
96fbaac
141c7d5
f4d1a0f
63f19ab
2b8ac67
2beb5ca
8344e24
4554df8
b1a9238
5742ebc
fdc86e4
99511b3
a916a1b
40b86ab
e788376
8bd8893
c6b4bc1
4eddd5e
05c09a2
8490d59
9be4543
75cba7d
129af6e
fe90213
d07d654
43b796e
3b0e1b1
3378f66
4d18a43
09f9473
ce09201
1acefad
7a6811b
ca69fe2
7746af3
fad0ac5
fbbc297
8562d0b
c639256
9b663c6
ecc88d7
614b602
19d95a8
6b2934c
e88babd
29284eb
e15d5d8
9e04e8b
b5f747b
e0ada18
ff40395
38c58b4
0a9d504
ab7a557
6e02c96
5d90297
bb66b9d
2df1492
64e8a3a
dd91392
c01261d
566909f
303d6fa
ddcd75d
cca793e
8aa8b6a
84e4b94
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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) | ||
|
|
||
| --- | ||
|
|
||
|
|
@@ -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) | ||
|
|
||
| </details> | ||
|
|
||
|
|
@@ -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
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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 |
||
|
|
||
| </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>** | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Avoid linking root README to a feature branch. These links target Also applies to: 111-111, 127-127, 133-133 🤖 Prompt for AI Agents |
||
| </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 | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove duplicate top-level section heading.
🧰 Tools🪛 markdownlint-cli2 (0.22.1)[warning] 165-165: Multiple headings with the same content (MD024, no-duplicate-heading) 🤖 Prompt for AI Agents |
||
|
|
||
| ### 🗂️ Database Architecture Diagrams | ||
|
|
||
|
|
@@ -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
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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 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 |
||
|
|
||
| --- | ||
|
|
||
|
|
@@ -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"> | ||
|
|
@@ -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 | ||
|
|
||
|  | ||
|
|
@@ -184,4 +257,4 @@ This project uses several open-source tools and dependencies that supported its | |
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -287,4 +287,4 @@ let entities = [ | |
| module.exports = { | ||
| entities, | ||
| entityType, | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
🤖 Prompt for AI Agents