Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IDE Setup and UML Diagram added #2

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 110 additions & 0 deletions docs/IDE_Setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
# Setting up IDE
## 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 :

* <b>Import new project :</b>
```
File -> New -> Project from existing source
```
Then open project as <b>maven project</b> in IntelliJ.

* For importing multiple projects in intelliJ click on <b>maven</b> (in right toolbar) and click on <b>+</b> for opening multiple projects.
![add multiple projects](../media/add_multiple_projects.png)

* After importing all the projects in your IntelliJ, now reload all maven project for first time setup.
![reload projects](../media/reload_all_maven_projects.png)

### 2.2 setting configurations

For setting configuration for any project follow below steps :

* Goto edit configuration.
![edit config](../media/edit_configuration.png)

* Add new configuration of type Application.
![new conf type application](../media/type_application.png)

* Now give name to config, select module, select JRE, give path of main class of that module, select working directory as shown in picture.
![define properties](../media/add_name_and_module.png)

* For handling enviorment variables, click on edit enviorment variables (if this colum not shown by default, enable it from <b>modify-options</b>).
![enviorment variables](../media/env_variable.png)

* 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 :

* <b>Import Projects into Eclipse :</b>
```
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
```

![update all](../media/sts_update_all.png)

### 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.
![config properties](../media/sts_name_config.png)

* Now for handling Enviorment Variables click on Enviorment in config window.
Here we can put enviorment variable's value.
![Enviorment Variable](../media/sts_env_variable.png)

* 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
```
3 changes: 3 additions & 0 deletions docs/Schema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Database Schema :

![Database-Schema](../media/schema.png)
Binary file added media/add_multiple_projects.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/add_name_and_module.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/edit_configuration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/env_variable.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/reload_all_maven_projects.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/schema.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/sts_env_variable.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/sts_name_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/sts_update_all.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/type_application.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.