Hosting and Customizing Projects
The Projects capability is enabled by the Projects microservice which can be set up in any cloud environment or in an on-premise setup.
In addition, system administrators can also set up a reference implementation (Progressive Web App or PWA) and customize the look and feel based on the needs. See Customize the PWA to learn more.
Other services such as User, Notification, Scheduler, and Entity Management are optional. The Projects service can work with one or more existing implementations of the same.
To host a customized instance of Projects:
- Install Node.js® on Ubuntu 20.04 (Search for Install Node.js on Ubuntu 20.04 in the Tutorials section.).
- Set up Projects Service (requires MongoDB).
- Set up Gotenberg Service.
- Set up Interface Service (requires PostgreSQL).
- Set up the front end or UI using any one of the following methods:
- Customize the PWA.
- Integrate the Project Player to an existing portal.
Optionally, to set up supporting services do as follows:
- Install Apache Kafka® on Ubuntu 20.04 (Search for Install Apache Kafka on Ubuntu 20.04 in the Community search box.).
- Set up User Service (requires PostgreSQL).
- Set up Notification Service (requires PostgreSQL).
- Set up Scheduler Service (requires PostgreSQL).
- Set up Entity Management Service (requires MongoDB).
Additional Resources
| To learn more | See the following links |
|---|---|
| API Documentation | https://project-dev.elevate-apis.shikshalokam.org/project/api-doc |
| Projects Service | https://github.com/ELEVATE-Project/project-service |
| Interface Service | https://github.com/ELEVATE-Project/interface-service |
| Supporting Service: User Service | https://github.com/ELEVATE-Project/user.git |
| Supporting Service: Notification Service | https://github.com/ELEVATE-Project/notification.git |
| Supporting Service: Scheduler Service | https://github.com/ELEVATE-Project/scheduler.git |
| Supporting Service: Entity Management Service | https://github.com/ELEVATE-Project/entity-management |