Sunbird UCI
  • Overview of Sunbird UCI
  • 📙Learn
    • UCI use cases
    • UCI for Education(Case study)
    • Tech Overview
      • Glossary
      • High-level Architecture Design
      • Design Principles
      • Standards
  • 🚀Use
    • Choose your Persona
    • Adopter - Install and use UCI
      • Pre-requisites, Installation Setup, Post Setup
      • Setting up your very first conversation
      • API Documentation
      • Data Exhaust and Analytics
      • Posthog Event
      • Whatsapp (Netcore)
      • Environment Variables
    • Developer - Contribute to UCI
      • UCI Basics
        • XMessage Specification
        • Transformers
          • ODK Transformer
            • Interactive-Messages
            • Media Messages
            • Location
          • Broadcast Transformer
        • Adapters
          • Firebase Notification Adapter
        • User Segment
        • Schema Overview
          • UCI Core Schema
            • XMessage Schema
            • Assessment DB Schema
          • UCI API Schema
      • Development environment
        • Backend Setup
        • Setting up IDE
        • Environment variable setup
        • Debug services
        • Build and Execute UCI
        • Frontend Setup (Admin Console)
        • Frontend Setup (PWA)
        • Transport Socket
      • API Documentation
        • Bot Setup APIs
        • History APIs
        • Direct Message APIs
        • Vault APIs
      • Database Schema
        • Cassandra Xmessage Database
        • Postgres Forms Database
        • Postgres User Analytics Database
        • Postgres Comms Database
      • Contribution Guide
        • Your first PR
        • Contribute an Adapter
        • Adapter Implementation
        • Create a Transformer
    • Contact the administrator
  • ✅Releases
    • Release V2
  • 🤝Engage
    • Software License
    • Acceptable Use Policy
    • Terms of Service
    • Source Code
    • Discussion Forum
Powered by GitBook
On this page
  • 1. Overview
  • 2. Setting up IntelliJ
  • 3. Setting up Eclipse

Was this helpful?

Edit on GitHub
  1. Use
  2. Developer - Contribute to UCI
  3. Development environment

Setting up IDE

PreviousBackend SetupNextEnvironment variable setup

Last updated 1 year ago

Was this helpful?

1. Overview

In this doc we'll configure an IDE (Eclipse/IntelliJ) for setting up development enviorment for UCI.

2. Setting up IntelliJ

2.1 Importing Projects

  • Import new project

        File -> New -> Project from existing source  

    Then open project as maven project in IntelliJ.

  • For importing multiple projects in intelliJ click on maven (in right toolbar) and click on + for opening multiple projects.

  • After importing all the projects in your IntelliJ, now reload all maven project for first time setup.

2.2 Setting configurations

For setting configuration for any project follow below steps

  • Goto edit configuration.

  • Add new configuration of type Application.

  • Now give name to config, select module, select JRE, give path of main class of that module, select working directory as shown in picture.

  • For handling enviorment variables, click on edit enviorment variables (if this colum not shown by default, enable it from modify-options).

  • Make these configuration for following projects inbound orchestrator transformer outbound

2.3 Build and Run

Now we can build and Run the projects using below steps

  • Required Plugins to build the project maven docker lombok

  • Now simply select configuration and click on Run(Shift+F10), to run the project.

3. Setting up Eclipse

3.1 Importing Projects

  • Import Projects into Eclipse

    File 
        -> Import 
            -> Projects From Git 
                -> Existing Local Repository 
                    -> Select You project
                        -> Finish

Import all the project like this.

  • After Importing, Update all project for first time setup.

    Project
        -> Update Maven Project
            -> Select All Projects
                -> Update

3.2 Setting Configurations

For setting configuration for any project follow below steps

  • Make new Configuration for spring-boot-app

Run
    -> Run Configurations
        -> Spring Boot App
  • Now give name to config, select project, select main class of project and click Apply.

  • Now for handling Enviorment Variables click on Enviorment in config window. Here we can put enviorment variable's value.

  • Make these configuration for following projects : inbound orchestrator transformer outbound

3.3 Build and Run :

To build and Run in Eclipse, Simply Run the project as Spring Boot App.

Run
    -> Run As
        -> Spring Boot App
🚀
add multiple projects
reload projects
edit config
new conf type application
define properties
enviorment variables
update all