Projects Service

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 (Projects Service Only)

**Click to Expand Stand-Alone Setup Options**

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

I. Docker Setup (Recommended)

1. Ubuntu Setup

Go to the detailed Ubuntu Docker setup guide: **SETUP_STANDALONE_DOCKER_UBUNTU.md**

2. macOS Setup

Go to the detailed macOS Docker setup guide: **SETUP_STANDALONE_DOCKER_MACOS.md**

3. Windows Setup

Go to the detailed Windows Docker setup guide: **SETUP_STANDALONE_DOCKER_WINDOWS.md**

II. Native Setup (PM2 Managed Services)

1. Ubuntu Setup

Go to the detailed Ubuntu Native setup guide: **SETUP_STANDALONE_NATIVE_UBUNTU.md**

2. macOS Setup

Go to the detailed macOS Native setup guide: **SETUP_STANDALONE_NATIVE_MACOS.md**

3. Windows Setup

Go to the detailed Windows Native setup guide: **SETUP_STANDALONE_NATIVE_WINDOWS.md**

---

🚀 WITH SAMIKSHA SERVICE (Integrated Deployment)

**Click to Expand Integrated Setup Options**

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

I. Docker Setup (Recommended)

1. Ubuntu Setup

Go to the detailed Ubuntu Docker setup guide: **SETUP_SAMIKSHA_DOCKER_UBUNTU.md**

2. macOS Setup

Go to the detailed macOS Docker setup guide: **SETUP_SAMIKSHA_DOCKER_MACOS.md**

3. Windows Setup

Go to the detailed Windows Docker setup guide: **SETUP_SAMIKSHA_DOCKER_WINDOWS.md**

II. Native Setup (PM2 Managed Services)

1. Ubuntu Setup

Go to the detailed Ubuntu Native setup guide: **SETUP_SAMIKSHA_NATIVE_UBUNTU.md**

2. macOS Setup

Go to the detailed macOS Native setup guide: **SETUP_SAMIKSHA_NATIVE_MACOS.md**

3. Windows Setup

Go to the detailed Windows Native setup guide: **SETUP_SAMIKSHA_NATIVE_WINDOWS.md**

---

📖 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: View 1.0.0 Documentation

Postman Collections

• Projects Service API Collection

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 documentation here.

---

🤝 Team

Open Source Dependencies

Several open source dependencies that have aided Projects's development: