Skip to content

ELEVATE-Project/project-service

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Projects Service

GitHub package.json version (subfolder of monorepo) License


The Project building block facilitates the creation and engagement with micro-improvement projects.

💻 Supported Operating Systems

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

✨ Setup & Deployment Guide

This section outlines the different ways to set up the Projects Service. Please select the deployment environment and setup method that best suits your needs.


🚀 Stand Alone Setup

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.

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)


II. Native Setup (PM2 Managed Services)


🚀 Integrated Setup

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.

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)


II. Native Setup (PM2 Managed Services)


📖 Related Documentation & Tools

🗂️ Database Architecture Diagrams

Explore the database schemas for the ELEVATE-Project services below.
Click on a service name to expand and view the diagram.


📂 Entity Management Service (EMS)

Entity Management Diagram

📂 Project Service

Project Service Diagram

📂 Samiksha Service (Survey & Observation)

Samiksha Service Diagram

Tip: If the diagrams appear too small, you can right-click the image and select
"Open image in new tab" to view the full-resolution architectural details.


🧪 Postman Collections and API DOC


🛠️ Adding New Projects to the System

With SUP (Solution Upload Portal), you can seamlessly add new projects , survey and observation to the system.
Once it's successfully added, it becomes visible on the portal, ready for use and interaction.

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


🔖 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
    View 1.0.0 Documentation


👥 Team


Open Source Dependencies

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

NodeJS
Apache Kafka
Redis
Git
MongoDB
PostgreSQL
RabbitMQ

About

Repo for Project Capability

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 11