> For the complete documentation index, see [llms.txt](https://uci.sunbird.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://uci.sunbird.org/use/developer/development-environment/backend-setup.md).

# Backend Setup

### Getting Started

### 1. Introduction

The Unified Communications Interface (UCI) aims to democratize the use of different communication channels such as WhatsApp, Telegram, SMS, email and more for governance use cases through a standard configurable manner that is reusable and scalable across all governance use cases.

### 2. Overview

This Document help you to Setup UCI (Unified Communications Interface) Project and test APIs on your local machine.

### 3. Prerequisite

1. Install Git

```
    $ sudo apt-get update
    $ sudo apt-get upgrade
    $ sudo apt-get install git
```

1. Install Java 11

```
    $ sudo apt-get install openjdk-11-jdk
```

1. Install Docker
   * install docker using [docker](https://docs.docker.com/engine/install/ubuntu/) installation guide.
2. Install Cassandra
   * install cassandra using [cassandra](https://cassandra.apache.org/doc/latest/cassandra/getting_started/installing.html) installation guide.
3. Install Maven

```
    $ sudo apt-get install maven
```

1. Install IDE ([STS](https://spring.io/tools) / [Eclipse](https://www.eclipse.org/downloads/) / [IntelliJ](https://www.jetbrains.com/idea/download/))
2. Lombok Enabled
   * Enable [lombok](https://www.baeldung.com/lombok-ide) in Eclipse / STS / intelliJ.
3. Install [Postman](https://www.postman.com/downloads/) (for testing API)
4. Install Kafka, Zookeeper
   * install kafka using [kafka](https://www.onlinetutorialspoint.com/kafka/how-to-install-apache-kafka-on-ubuntu-18-04.html) installation guide.
5. Install Redis

* Install Redis using installation [guide](https://www.digitalocean.com/community/tutorials/how-to-install-and-secure-redis-on-ubuntu-18-04).

1. Install Postgresql

* Setup PostgreSQL using [Quickstart](https://www.postgresql.org/download/linux/ubuntu/) guide.

### 4. Setup

#### 4.1 For first time

1. Fork following repositories

```
    https://github.com/samagra-comms/dao
    https://github.com/samagra-comms/utils
    https://github.com/samagra-comms/message-rosa
    https://github.com/samagra-comms/adapter
    https://github.com/samagra-comms/outbound
    https://github.com/samagra-comms/orchestrator
    https://github.com/samagra-comms/inbound
    https://github.com/samagra-comms/transformer
    https://github.com/samagra-comms/broadcast-transformer
```

1. Clone all forked repositories

```
    git clone repository-link
```

1. Import all cloned repositories into IDE and checkout to the latest branch Eg. release-4.9.0
2. If project is not build by default then build using

```
    $ mvn clean install -U 
```

1. Add projects in IDE [link](/use/developer/development-environment/setting-up-ide.md)
2. Add [Enviorment Variable](broken://pages/kylVK0adlYVaxFg8SRqb) in IDE.
3. We can run the services via IDE. if you want to run these via terminal or docker use this [link](/use/developer/development-environment/build-and-execute-uci.md)

#### 4.2 Routine

1. Run spring boot application for following projects
   * Inbound
   * Orchestrator
   * Transformer
   * Broadcast Transformer
   * Outbound
2. To debug these service, we should follow the same routine. [Click here](/use/developer/development-environment/debug-services.md) to check the detailed overview of debugging services.

### 5. APIs

#### 5.1 For first time

1. Import following files to postman :
   * Samagra Inbound - [Apis.postman\_collection](https://github.com/samagra-comms/community/blob/main/media/Inbound-Sharing.postman_collection.json)
   * Samagra Transformer - [Apis.postman\_collection](https://github.com/samagra-comms/community/blob/main/media/Transformer-Sharing.postman_collection.json)
2. create new enviorment **inbound** with properties :

   | Variable |   Type  |  Initial Value |  Current Value |
   | :------: | :-----: | :------------: | :------------: |
   |  baseUrl | default | localhost:8085 | localhost:8085 |
3. create new enviorment **transformer** with following properties :

   | Variable |   Type  |  Initial Value |  Current Value |
   | :------: | :-----: | :------------: | :------------: |
   |  baseUrl | default | localhost:9091 | localhost:9091 |

#### 5.2 Routine :

1. Test bot APIs with :

```
    Collections
    .
    └── Samagra Inbound - Apis 
                └── Bot - Messages
                        └── ...
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://uci.sunbird.org/use/developer/development-environment/backend-setup.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.