diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml
new file mode 100644
index 0000000..7944dda
--- /dev/null
+++ b/.github/workflows/scorecard.yml
@@ -0,0 +1,79 @@
+# This workflow uses actions that are not certified by GitHub. They are provided
+# by a third-party and are governed by separate terms of service, privacy
+# policy, and support documentation.
+
+name: Scorecard supply-chain security
+on:
+ # For Branch-Protection check. Only the default branch is supported. See
+ # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
+ branch_protection_rule:
+ # To guarantee Maintained check is occasionally updated. See
+ # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
+ schedule:
+ - cron: '36 16 * * 3'
+ push:
+ branches: [ "add-license-1" ]
+
+# Declare default permissions as read only.
+permissions:
+ contents: read
+
+jobs:
+ analysis:
+ name: Scorecard analysis
+ runs-on: ubuntu-latest
+ # `publish_results: true` only works when run from the default branch. conditional can be removed if disabled.
+ if: github.event.repository.default_branch == github.ref_name || github.event_name == 'pull_request'
+ permissions:
+ # Needed to upload the results to code-scanning dashboard.
+ security-events: write
+ # Needed to publish results and get a badge (see publish_results below).
+ id-token: write
+ # Uncomment the permissions below if installing in a private repository.
+ # contents: read
+ # actions: read
+
+ steps:
+ - name: "Checkout code"
+ uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+ with:
+ persist-credentials: false
+
+ - name: "Run analysis"
+ uses: ossf/scorecard-action@f49aabe0b5af0936a0987cfb85d86b75731b0186 # v2.4.1
+ with:
+ results_file: results.sarif
+ results_format: sarif
+ # (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
+ # - you want to enable the Branch-Protection check on a *public* repository, or
+ # - you are installing Scorecard on a *private* repository
+ # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action?tab=readme-ov-file#authentication-with-fine-grained-pat-optional.
+ # repo_token: ${{ secrets.SCORECARD_TOKEN }}
+
+ # Public repositories:
+ # - Publish results to OpenSSF REST API for easy access by consumers
+ # - Allows the repository to include the Scorecard badge.
+ # - See https://github.com/ossf/scorecard-action#publishing-results.
+ # For private repositories:
+ # - `publish_results` will always be set to `false`, regardless
+ # of the value entered here.
+ publish_results: true
+
+ # (Optional) Uncomment file_mode if you have a .gitattributes with files marked export-ignore
+ # file_mode: git
+
+ # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
+ # format to the repository Actions tab.
+ - name: "Upload artifact"
+ uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
+ with:
+ name: SARIF file
+ path: results.sarif
+ retention-days: 5
+
+ # Upload the results to GitHub's code scanning dashboard (optional).
+ # Commenting out will disable upload of results to your repo's Code Scanning dashboard
+ - name: "Upload to code-scanning"
+ uses: github/codeql-action/upload-sarif@v4
+ with:
+ sarif_file: results.sarif
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..3c3350c
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,2 @@
+All participants agree to abide by the [Code of Conduct](https://lfprojects.org/policies/code-of-conduct/). Please contact [conduct@lfenergy.org](conduct@lfenergy.org) to report any
+violations or concerns.
diff --git a/COMMITERS.csv b/COMMITERS.csv
new file mode 100644
index 0000000..217e7bb
--- /dev/null
+++ b/COMMITERS.csv
@@ -0,0 +1,3 @@
+Name, Email, Github ID
+xxx xxxx, xxx@axmsoftware.com, axmsoftware
+Will Sams, will@samswebs.com, willsams
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..ac13e66
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,107 @@
+# Contributing to APIS
+
+Thank you for your interest in contributing to APIS! We welcome contributions from the community to help improve and grow this project.
+
+## How to Contribute
+
+### Reporting Issues
+
+If you encounter any bugs, have feature requests, or want to suggest improvements, please open an issue in the relevant sub-repository under the [Hyphae organization](https://github.com/hyphae). When filing an issue, please provide:
+
+- A clear title and description
+- Steps to reproduce (if applicable)
+- Expected and actual behavior
+- Any relevant logs or screenshots
+
+### Contributing Code
+
+The main repository (APIS) does not contain code directly but serves as the build orchestrator for the following sub-repositories:
+
+- [apis-bom](https://github.com/hyphae/apis-bom)
+- [apis-ccc](https://github.com/hyphae/apis-ccc)
+- [apis-common](https://github.com/hyphae/apis-common)
+- [apis-emulator](https://github.com/hyphae/apis-emulator)
+- [apis-log](https://github.com/hyphae/apis-log)
+- [apis-main](https://github.com/hyphae/apis-main)
+- [apis-main_controller](https://github.com/hyphae/apis-main_controller)
+- [apis-service_center](https://github.com/hyphae/apis-service_center)
+- [apis-tester](https://github.com/hyphae/apis-tester)
+- [apis-web](https://github.com/hyphae/apis-web)
+
+Each of these sub-repositories may have different contribution requirements based on the technology stack (Java, Groovy or Python). Please refer to their respective README.md files.
+
+#### 1. Fork the Relevant Repository
+
+Start by forking and cloning the repository you wish to contribute to.
+
+```bash
+# Fork the repository and clone it locally. Example for apis-common
+git clone https://github.com/hyphae/apis-common.git
+cd apis-common
+```
+
+#### 2. Create a Branch
+
+Create a new branch for your work:
+
+```bash
+git checkout -b feature-branch
+```
+
+#### 3. Implement Changes
+
+Make your changes following the coding standards of the project. Ensure your code is well-documented and includes tests where applicable.
+
+#### 4. Run Tests
+
+Before submitting your changes, make sure to test them:
+
+```bash
+mvn test # Java projects
+```
+
+#### 5. Commit Changes
+
+Follow the projectโs commit message conventions. A good commit message format is:
+
+```text
+[Type] Short description
+
+Detailed explanation of the changes (if necessary)
+```
+
+Examples:
+
+```text
+[Fix] Corrected validation logic for job assignments
+[Feature] Added new user role permissions
+```
+
+#### 6. Submit a Pull Request (PR)
+
+Push your changes to your fork and create a pull request against the `main` branch of the repository. Provide a detailed explanation of the changes in the PR description.
+
+### Code Review Process
+
+All contributions go through a code review process:
+
+1. A maintainer will review your PR and may request changes.
+2. Once approved, your changes will be merged into the main branch.
+3. If necessary, your changes will be included in the next release.
+
+### Contribution Guidelines
+
+- Follow the projectโs coding style and conventions.
+- Ensure changes do not introduce security vulnerabilities.
+- Write clear and descriptive commit messages.
+- Be respectful and constructive in discussions and code reviews.
+
+### Community Contributions
+
+In addition to code, you can contribute by:
+
+- Writing and improving documentation.
+- Helping answer questions in discussions and issues.
+- Reporting bugs and suggesting features.
+
+Thank you for contributing to APIS! ๐
diff --git a/GOVERNANCE.md b/GOVERNANCE.md
new file mode 100644
index 0000000..223cc41
--- /dev/null
+++ b/GOVERNANCE.md
@@ -0,0 +1,65 @@
+# APIS Project Governance Policy
+
+## Overview
+
+This project aims to be governed in a transparent, accessible way for the benefit of the community. All participation in this project is open and not bound to corporate affiliation. Participants are bound to the project's [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Project Roles
+
+### Contributor
+
+The contributor role is the starting role for anyone participating in the
+project and wishing to contribute code.
+
+#### Process for Becoming a Contributor
+
+* Review the [Contribution Guidelines](CONTRIBUTING.md) to ensure your contribution is inline with the project's coding and styling guidelines.
+* Submit your code as a PR with the appropriate DCO sign-off.
+* Have your submission approved by the committer(s) and merged into the codebase.
+
+### Committer
+
+The committer role enables the contributor to commit code directly to the repository, but also comes with the responsibility of being a responsible leader in the community.
+
+#### Process for Becoming a Committer
+
+* Show your experience with the codebase through contributions and engagement on the community channels.
+* Request to become a committer. To do this, create a new pull request that adds your name and details to the [Committers File](COMMITTERS.csv) and request existing committers to approve.
+* After the majority of committers approve you, merge in the PR. Be sure to tag the person managing the GitHub permissions to update the committers team in GitHub.
+
+#### Committer Responsibilities
+
+* Monitor project communication channels.
+* Triage GitHub issues and perform pull request reviews for other committers and the community.
+* Ensure that ongoing PRs are moving forward at the right pace or closing them.
+* Dedicate at least 25% of their time (~1.25 business days per week) to the project.
+
+#### When Does a Committer Lose Committer Status?
+
+If a committer is no longer interested or cannot perform the committer duties listed above, they should volunteer to be moved to emeritus status. In extreme cases, this can also occur by a vote of the committers per the voting process below.
+
+### Technical Steering Committee (TSC)
+
+The Technical Steering Committee (TSC) is responsible for the overall project health and direction, coordination of activities, and working with other projects and committees as needed for the continued growth of the project.
+
+See [TSC Readme](tsc/README.md) for details.
+
+## Release Process
+
+Project releases will occur on a scheduled basis as agreed to by the committers. See [RELEASE.md](RELEASE.md) for details.
+
+## Conflict Resolution and Voting
+
+In general, we prefer that technical issues and committer membership are amicably worked out between the persons involved. If a dispute cannot be decided independently, the committers can be called in to decide an issue. If the committers themselves cannot decide an issue, the issue will be resolved by voting. The voting process is a simple majority in which each committer receives one vote.
+
+## Communication
+
+This project, just like all of open source, is a global community. In addition to the [Code of Conduct](CODE_OF_CONDUCT.md), this project will:
+
+* Keep all communication on open channels (mailing list, forums, chat).
+* Be respectful of time and language differences between community members (such as scheduling meetings, email/issue responsiveness, etc.).
+* Ensure tools are able to be used by community members regardless of their region.
+
+If you have concerns about communication challenges for this project, please contact the committers.
+
+Thank you for being part of the APIS community and helping maintain a well-governed, transparent project!
diff --git a/Makefile b/Makefile
index 8e1319d..bd45327 100644
--- a/Makefile
+++ b/Makefile
@@ -1,6 +1,36 @@
GIT_BASE_URL=https://github.com/hyphae
+.PHONY: help
+help:
+ @printf "\nClone Repositories:\n"
+ @printf " make apis-bom - Clone APIS BOM repository\n"
+ @printf " make apis-common - Clone APIS Common repository\n"
+ @printf " make apis-main - Clone APIS Main repository\n"
+ @printf " make apis-ccc - Clone APIS CCC repository\n"
+ @printf " make apis-log - Clone APIS Log repository\n"
+ @printf " make apis-web - Clone APIS Web repository\n"
+ @printf " make apis-emulator - Clone APIS Emulator repository\n"
+ @printf " make apis-main_controller - Clone APIS Main Controller repository\n"
+ @printf " make apis-service_center - Clone APIS Service Center repository\n"
+ @printf " make apis-tester - Clone APIS Tester repository\n\n"
+ @printf "Build Targets:\n"
+ @printf " make build-apis-* - Build a specific APIS module\n"
+ @printf " make build - Build all APIS modules\n\n"
+ @printf "Update Repositories:\n"
+ @printf " make update-apis-* - Update a specific APIS repository\n"
+ @printf " make update - Update all APIS repositories\n\n"
+ @printf "Clean Targets:\n"
+ @printf " make clean-apis-* - Clean a specific APIS module\n"
+ @printf " make clean - Clean all APIS modules\n\n"
+ @printf "Run Targets:\n"
+ @printf " make run-apis-* - Run a specific APIS module\n"
+ @printf " make run-mongodb - Run MongoDB service\n"
+ @printf " make run - Run all APIS services\n\n"
+ @printf "Stop Targets:\n"
+ @printf " make stop-apis-* - Stop a specific APIS module\n"
+ @printf " make stop-mongodb - Stop MongoDB service\n"
+ @printf " make stop - Stop all APIS services\n"
apis-bom:
git clone $(GIT_BASE_URL)/apis-bom.git
diff --git a/README.md b/README.md
index e0b9e74..aaf69d8 100644
--- a/README.md
+++ b/README.md
@@ -1,146 +1,375 @@
-# Autonomous Power Interchange System (APIS)
-
-# APIS features
-By accommodating P2P energy sharing between distributed batteries, it is possible to build a microgrid that utilizes variable renewable energy(VRE) as the main power source and enhances the resilience of the power system. These distributed batteries absorb fluctuations of VRE generation and improve community self-sufficiency by balancing supply and demand within the community.
-
-Click [here](https://www.sonycsl.co.jp/tokyo/11481/) for details
-
-# Technoogy
-
-## Physical Peer to Peer(PP2P) energy sharing
-This technology achieves a fixed amount of energy sharing between batteries by constant current control. It offset a shortage of one battery with delivering the necessary amount from a surplus of other battery. It is possible to send a fixed amount of power between specific users (batteries), which was difficult to realize by the voltage control, and it is possible to transact PP2P energy trading between users on the condition of the required energy amount and energy price.
-
-
-
-## Autonomous distributed control
-Software with the same functions is installed in each battery system, and the software implements energy sharing according to the transaction conditions (time window, energy amount, energy price, etc.) of each battery system. It is a flexible energy trading system that allows various transaction conditions to be set for each battery system and that the conditions can be dynamically changed for each time window.
-
-
-
-
-
-
-## Software
-The software that realizes the above technology and makes it possible to easily construct a DC microgrid is released.
-
-### โผ Software required to simulate energy exchange using a hardware emulator
- - [apis-main](https://github.com/hyphae/apis-main)
- Software installed on each node to provide bi-directional energy exchange with autonomous decentralized control
- See apis-main's [Documentation](https://github.com/hyphae/apis-main/blob/master/doc/en/apis-main_specification_en.md) for more information.
- - [apis-main_controller](https://github.com/hyphae/apis-main_controller)
- Software that visualizes the status of apis-main installed on each node and the status of energy exchange between nodes
- See apis-main_controller's [Documentation](https://github.com/hyphae/apis-main_controller/blob/master/doc/en/apis-main-controller_specification_en.md) for more information.
- - [apis-web](https://github.com/hyphae/apis-web)
- Software that acquires necessary information for visualization from apis-main and provides it to apis-main_controller
- See apis-web's [Documentation](https://github.com/hyphae/apis-web/blob/master/doc/en/apis-web_specification_en.md) for more information.
- - [apis-emulator](https://github.com/hyphae/apis-emulator)
- Software to emulate hardware such as DC/DC converters and batteries
- See apis-emulator's [Documentation](https://github.com/hyphae/apis-emulator/blob/master/doc/en/apis-emulator_specification_en.md) for more information.
- - [apis-service_center](https://github.com/hyphae/apis-service_center) (Added on December 24, 2020)
- Software to provide information required by the administrators and users of clusters constructed of apis-main services installed in each unit.
- See apis-service_center's [Documentation](https://github.com/hyphae/apis-service_center/blob/main/doc/en/apis-service_center_specification_EN.md) for more information.
- - [apis-ccc](https://github.com/hyphae/apis-ccc) (Added on December 24, 2020)
- Software to uploade information that is related to energy sharing to apis-service_center.
- See apis-ccc's [Documentation](https://github.com/hyphae/apis-ccc/blob/main/doc/en/apis-ccc_specification_EN.md) for more information.
- - [apis-log](https://github.com/hyphae/apis-log) (Added on December 24, 2020)
- Software to receive information from apis-main by multicast via a communication line and storing that information in a database.
- See apis-log's [Documentation](https://github.com/hyphae/apis-log/blob/main/doc/en/apis-log_specification_EN.md) for more information.
- - [apis-tester](https://github.com/hyphae/apis-tester) (Added on December 24, 2020)
- Software to test and evaluation of apis-main.
- See apis-tester's [Documentation](https://github.com/hyphae/apis-tester/blob/main/doc/en/apis-tester_specification_EN.md) for more information.
-
- ## Installation
-
- [Operating Environment]
- The above software has been tested on the following operating systems.
- - Ubuntu 18.04, 20.04
- - CentOS 7, 8
- - macOS Catalina, Big Sur
-
- ใ* Virtual environments are not supported.
-
- [Preparation]
- It is assumed that the necessary software are installed.
- The following is an example of an advance preparation for Ubuntu 18.04.
- * Install the JDK if it's not already installed.
- * Python3.6.9 or later is required.
- * Sqlite3.8.3 or later is required. (CentOS 7)
-
+# ๐ APIS - Autonomous Power Interchange System
+[](https://scorecard.dev/viewer/?uri=github.com/hyphae/APIS)
+
+---
+
+## ๐ฏ What is APIS?
+
+**APIS** is an innovative open-source platform that enables **Physical Peer-to-Peer (PP2P) energy sharing** between distributed batteries in microgrids. By leveraging Variable Renewable Energy (VRE) sources, APIS builds resilient microgrids that enhance community self-sufficiency and reduce dependency on traditional centralized power generation.
+
+### ๐ Why This Matters
+
+Imagine if your home battery could automatically share power with your neighbors when they need it, and get power back when you need it. That's exactly what APIS does!
+
+- **๐ฐ Save Money**: Share excess solar power instead of selling it back to the grid at low prices
+- **๐ Stay Powered**: Never run out of energy when your neighbors have extra
+- **๐ฑ Go Green**: Maximize renewable energy use in your community
+- **๐ Be Independent**: Reduce reliance on big power companies
+- **๐ก๏ธ Build Resilience**: Keep communities powered during grid outages
+
+Click [here](https://www.sonycsl.co.jp/tokyo/11481/) for more details about the research behind APIS.
+
+---
+
+## ๐ง How It Works
+
+
+
+### Physical Peer to Peer (PP2P) Energy Sharing
+
+APIS achieves **precise energy sharing between batteries using constant current control**. This technology:
+
+- โ
**Offsets energy shortages** by delivering the necessary amount from surplus batteries
+- โ
**Enables fixed-amount power transfers** between specific users (batteries)
+- โ
**Supports P2P energy trading** based on energy amount and price conditions
+- โ
**Works where voltage control fails** - providing true peer-to-peer transactions
+
+
+
+### Autonomous Distributed Control
+
+**The same software is installed on every battery system**, creating a truly decentralized network where:
+
+- ๐ค **Smart Decision Making**: Each system makes autonomous trading decisions
+- โ๏ธ **Flexible Conditions**: Set different trading rules for each battery system
+- ๐ **Dynamic Updates**: Change conditions for each time window
+- ๐ **Custom Parameters**: Configure energy amount, pricing, and timing preferences
+
+
+
+---
+
+## ๐ Quick Start (5 Minutes)
+
+**Want to try it out? Here's how:**
+
+```bash
+# 1. Get the code
+git clone https://github.com/hyphae/APIS.git
+cd APIS
+
+# 2. Build everything
+make build
+
+# 3. Start the system
+make run
+```
+
+**That's it!** Now open your web browser and go to:
+
+| Service | URL | What You'll See |
+|---------|-----|-----------------|
+| ๐ **Main Controller** | `http://0.0.0.0:4382/` | Primary dashboard and controls |
+| ๐ง **Hardware Emulator** | `http://0.0.0.0:4390/` | Simulate batteries and DC/DC converters |
+| ๐งช **Testing Interface** | `http://0.0.0.0:10000/` | System testing and validation tools |
+| ๐ข **Service Center** | `http://127.0.0.1:8000/static/ui_example/staff/visual.html` | Admin interface (login: admin/admin) |
+
+### Starting Your First Energy Exchange
+
+
+
+1. **Access the Main Controller** at `http://0.0.0.0:4382/`
+2. **Clear your browser cache** (recommended for best performance)
+3. **Set Global Mode to "Run"** to start energy exchange simulation
+
+
+
+4. **Watch the magic happen** - energy will start flowing between simulated batteries automatically!
+
+**To stop the system:**
+```bash
+make stop
+```
+
+---
+
+## ๐ ๏ธ System Components
+
+
+
+APIS consists of several interconnected software modules that work together seamlessly:
+
+### ๐ Core Components (Essential for Basic Operation)
+
+| Component | Purpose | What It Does |
+|-----------|---------|--------------|
+| **๐ง [apis-main](https://github.com/hyphae/apis-main)** | Energy Exchange Engine | Makes smart trading decisions and handles bi-directional energy flow with autonomous control ([Documentation](https://github.com/hyphae/apis-main/blob/master/doc/en/apis-main_specification_en.md)) |
+| **๐ [apis-main_controller](https://github.com/hyphae/apis-main_controller)** | Visual Dashboard | Monitor system status and energy exchanges in real-time through an easy web interface ([Documentation](https://github.com/hyphae/apis-main_controller/blob/master/doc/en/apis-main-controller_specification_en.md)) |
+| **๐ [apis-web](https://github.com/hyphae/apis-web)** | Web Service Layer | Provides data and API services, connects everything to the internet securely ([Documentation](https://github.com/hyphae/apis-web/blob/master/doc/en/apis-web_specification_en.md)) |
+| **๐ง [apis-emulator](https://github.com/hyphae/apis-emulator)** | Hardware Simulator | Test the system without real batteries - simulates DC/DC converters and battery behavior ([Documentation](https://github.com/hyphae/apis-emulator/blob/master/doc/en/apis-emulator_specification_en.md)) |
+
+### ๐ข Extended Services (For Advanced Users & Communities)
+
+| Component | Purpose | What It Does |
+|-----------|---------|--------------|
+| **๐ข [apis-service_center](https://github.com/hyphae/apis-service_center)** | Community Management | Admin tools for managing large networks, user services, and cluster information *Added Dec 24, 2020* ([Documentation](https://github.com/hyphae/apis-service_center/blob/main/doc/en/apis-service_center_specification_EN.md)) |
+| **๐ก [apis-ccc](https://github.com/hyphae/apis-ccc)** | Communication Hub | Coordinates between different APIS networks and uploads energy sharing information *Added Dec 24, 2020* ([Documentation](https://github.com/hyphae/apis-ccc/blob/main/doc/en/apis-ccc_specification_EN.md)) |
+| **๐ [apis-log](https://github.com/hyphae/apis-log)** | Smart Analytics | Receives data via multicast and stores comprehensive system analytics in database *Added Dec 24, 2020* ([Documentation](https://github.com/hyphae/apis-log/blob/main/doc/en/apis-log_specification_EN.md)) |
+| **๐งช [apis-tester](https://github.com/hyphae/apis-tester)** | Quality Assurance | Automated testing and evaluation framework for system validation *Added Dec 24, 2020* ([Documentation](https://github.com/hyphae/apis-tester/blob/main/doc/en/apis-tester_specification_EN.md)) |
+
+### โก Real Hardware Integration (For Production Deployments)
+
+| Component | Purpose | What It Does |
+|-----------|---------|--------------|
+| **โ๏ธ [apis-dcdc_batt_comm](https://github.com/hyphae/apis-dcdc_batt_comm)** | Hardware Driver | Controls actual DC/DC converters and batteries (replaces emulator for real deployments) ([Documentation](https://github.com/hyphae/apis-dcdc_batt_comm/blob/master/doc/en/apis-dcdc_batt_comm_specification_en.md)) |
+| **๐ [apis-build_version_up_system](https://github.com/hyphae/apis-build_version_up_system)** | Deployment Tool | Automates multi-node software installation and configuration for production systems ([Documentation](https://github.com/hyphae/apis-build_version_up_system/blob/main/doc/en/apis-build_version_up_system_specification_EN.md)) |
+| **๐ [apis-hw-info](https://github.com/SonyCSL/apis-hw-info)** | Hardware Guide | Reference documentation for compatible hardware and technical specifications ([Documentation](https://github.com/hyphae/apis-hw-info/blob/main/MAIN-DOCUMENT_EN.md)) |
+
+---
+
+## ๐ป Installation Guide
+
+
+
+### ๐ฅ๏ธ System Requirements
+
+**Tested Operating Systems:**
+- **Ubuntu**: 18.04, 20.04 โ
+- **CentOS**: 7, 8 โ
+- **macOS**: Catalina, Big Sur โ
+
+> **โ ๏ธ Important**: Virtual environments are not currently supported.
+
+### ๐ Prerequisites
+
+**Before you start, make sure you have:**
+
+```bash
+# Ubuntu/Debian systems:
+sudo apt update
+sudo apt install git make maven groovy python3-venv python3-pip
+```
+
+**Also Required:**
+- **Java Development Kit (JDK)**: Latest version
+- **Python**: 3.6.9 or later
+- **SQLite**: 3.8.3 or later (required for CentOS 7)
+
+### ๐ Installation Steps
+
+**1. Clone the Repository**
```bash
-$ sudo apt install git
-$ sudo apt install make
-$ sudo apt install maven
-$ sudo apt install groovy
-$ sudo apt install python3-venv
-$ sudo apt install python3-pip
-$ sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 9DA31620334BD75D9DCB49F368818C72E52529D4
-$ echo "deb [ arch=amd64 ] https://repo.mongodb.org/apt/ubuntu bionic/mongodb-org/4.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-4.0.list
-$ sudo apt install mongodb-org
+git clone https://github.com/hyphae/APIS.git
+cd APIS
```
-[APIS related software bach installation]
- Install all of the above APIS related software at one time.
- See each software repository for the individual installation and execution of each software.
-
- ```bash
-$ git clone https://github.com/hyphae/APIS.git
-$ cd APIS
-$ make build
+**2. Build All Components**
+```bash
+make build
+```
+*This downloads and compiles all necessary software - takes 5-10 minutes*
+
+**3. Start the System**
+```bash
+make run
```
-* If an error occurs with the "make build" or "make run" command, open the terminal again and run it.
-
-## Running
-Run all of the above APIS related software at once.
+**4. Verify Installation**
+- Open `http://0.0.0.0:4382/` in your browser
+- You should see the APIS control panel
+- All components should show as "Running" status
+
+### ๐ง Troubleshooting
+
+**If you encounter issues:**
+
+- **"Command not found" errors**: Install all prerequisites first
+- **"make build" or "make run" fails**: Open a new terminal and try again
+- **Port conflicts**: Stop other web servers or restart your computer
+- **Permission issues**: Check file permissions or try with appropriate privileges
+
+---
- ```bash
-$ make run
+## ๐ How to Use APIS
+
+### ๐ฎ Basic Operations
+
+**Start the System:**
+```bash
+make run
```
- After running each software, access the followings in your browser to display.
-
- 0.0.0.0:4382/ -> apis-main_controller
- 0.0.0.0:4390/ -> apis-emulator
- 0.0.0.0:10000/ -> apis-tester
- http://127.0.0.1:8000/static/ui_example/staff/visual.html -> apis-service_center (account/pwd = admin/admin)
-
-
-
- The following picture is apis-main_controller.
- Flash an cache once.
-
- 
-
- Simulate energy exchange with setting Global Mode to "Run".
-
- 
-
-
-
-
- ## Stopping
-Stop all of the above APIS related software at once.
-
- ```bash
-$ make stop
+**Monitor System Health:**
+- Check component status through the Main Controller interface
+- Monitor energy flow patterns and transaction logs
+- Review system performance metrics in the Service Center
+
+**Stop the System:**
+```bash
+make stop
```
-
-### โผ Software and hardware information required for energy exchange using actual DC/DC converters and batteries
-Use apis-dcdc_batt_comm instead of apis-emulator.
-
- - [apis-dcdc_batt_comm](https://github.com/hyphae/apis-dcdc_batt_comm)
- Sample device driver to control DC/DC converters and batteries
- See apis-dcdc_batt_comm's [Documentation](https://github.com/hyphae/apis-dcdc_batt_comm/blob/master/doc/en/apis-dcdc_batt_comm_specification_en.md) for more information.
- - [apis-build_version_up_system](https://github.com/hyphae/apis-build_version_up_system)
- This tool clones all of the software needed to build the APIS evaluation environment from GitHub/hyphae in a single batch, builds the software, generates the various configuration files required for APIS operation according to the configuration file, and then installs all of the software on multiple nodes.
- See apis-build_version_up_systems's [Documentation](https://github.com/hyphae/apis-build_version_up_system/blob/main/doc/en/apis-build_version_up_system_specification_EN.md) for more information.
- - [apis-hw-info](https://github.com/SonyCSL/apis-hw-info)
- Hardware reference information
- See apis-hw-info's [Documentation](https://github.com/hyphae/apis-hw-info/blob/main/MAIN-DOCUMENT_EN.md) for more information.
-
- ## License
- [Apache License Version 2.0](https://github.com/hyphae/APIS/blob/master/LICENSE)
-
-
-## Notice
- [Notice](https://github.com/hyphae/APIS/blob/master/NOTICE.md)
+
+### โ๏ธ Configuration
+
+**Energy Trading Setup:**
+1. Access the web interfaces to modify transaction parameters
+2. Adjust energy trading conditions per time window
+3. Configure battery system preferences and constraints
+4. Set pricing rules and availability schedules
+
+**System Monitoring:**
+- Real-time energy flow visualization
+- Transaction history and analytics
+- Performance metrics and system health
+- Community-wide energy balance reports
+
+---
+
+## ๐ Key Benefits
+
+
+
+### For Homeowners ๐
+- **๐ฐ Lower Bills**: Reduce electricity costs significantly
+- **๐ Backup Power**: Access community energy when your battery runs low
+- **๐ค Fully Automatic**: Set preferences once, let APIS handle everything
+- **๐ฑ Easy Monitoring**: Simple web interface accessible from any device
+
+### For Communities ๐๏ธ
+- **๐ฑ Environmental Impact**: Maximize clean energy use and reduce carbon footprint
+- **๐ก๏ธ Disaster Resilience**: Keep power flowing during grid outages and emergencies
+- **๐ผ Economic Benefits**: Keep energy money in the community
+- **๐ Energy Independence**: Reduce reliance on big power companies
+
+### For Developers ๐จโ๐ป
+- **๐ Open Source**: Free to use and modify under Apache License 2.0
+- **๐ Well Documented**: Comprehensive guides and API references
+- **๐ค Active Community**: Get help and contribute back
+- **โ
Proven Technology**: Already working in real installations worldwide
+
+---
+
+## ๐ค Contributing
+
+We welcome contributions from the community! Here's how you can help:
+
+### ๐ Ways to Contribute
+
+**Even if you're not a programmer:**
+- ๐ Improve documentation (fix typos, add examples)
+- ๐งช Test new features and report bugs
+- ๐ฃ๏ธ Help answer questions in forums
+- ๐ข Share your APIS success stories
+
+**If you code:**
+- ๐ Fix bugs and improve stability
+- โก Add new features and capabilities
+- ๐ง Create better tools and interfaces
+- ๐ Improve performance and efficiency
+
+**If you're a hardware person:**
+- ๐ Create drivers for new battery systems
+- โ๏ธ Design better integration methods
+- ๐ Contribute hardware compatibility guides
+- ๐ ๏ธ Help with installation and setup
+
+### ๐ Getting Started
+
+1. **Fork the Repository**: Create your own fork of the APIS project
+2. **Create Feature Branch**: `git checkout -b feature/your-feature-name`
+3. **Make Changes**: Implement your improvements or fixes
+4. **Test Thoroughly**: Ensure all tests pass and functionality works
+5. **Submit Pull Request**: Describe your changes and their benefits
+
+### ๐ Contribution Guidelines
+
+- Follow existing code style and conventions
+- Include comprehensive tests for new features
+- Update documentation for any API changes
+- Provide clear commit messages and PR descriptions
+
+---
+
+## ๐ Getting Help & Support
+
+### ๐ Self-Service Options
+- **๐ Documentation**: Most questions answered in our comprehensive guides
+- **๐ GitHub Issues**: Search existing problems and solutions
+- **๐ฌ Community Forums**: Ask and answer questions with other users
+
+### ๐ Direct Support
+- **๐ Bug Reports**: Create a GitHub issue for bug reports
+- **๐ก Feature Requests**: Suggest improvements through GitHub issues
+- **๐ Security Issues**: Contact maintainers directly for sensitive matters
+
+---
+
+## ๐ License & Legal
+
+**APIS** is released under the **[Apache License Version 2.0](https://github.com/hyphae/APIS/blob/master/LICENSE)**
+
+**What this means for you:**
+- โ
Use it for free, forever
+- โ
Modify it however you want
+- โ
Use it in commercial products
+- โ
No fees or royalties
+- โ
Patent protection included
+
+**What you need to do:**
+- ๐ Include the license notice if you redistribute
+- ๐ Note any changes you make
+- ๐ That's pretty much it!
+
+See the [LICENSE](https://github.com/hyphae/APIS/blob/master/LICENSE) file for all legal details.
+See the [NOTICE](https://github.com/hyphae/APIS/blob/master/NOTICE.md) for additional notices.
+
+---
+
+## ๐ฏ What's Next for APIS
+
+### ๐ Coming Soon
+- **๐ฑ Mobile App**: Control APIS from your smartphone
+- **โ๏ธ Cloud Integration**: Connect with major cloud platforms
+- **๐ค AI Optimization**: Smarter energy trading decisions
+- **๐ More Hardware**: Support for additional battery brands
+
+### ๐ Long-Term Vision
+- **๐ Global Network**: Connect APIS communities worldwide
+- **๐ฑ Carbon Credits**: Automatic environmental impact tracking
+- **๐น Dynamic Pricing**: Real-time energy market integration
+- **๐ฅ Peer Review**: Community-driven system improvements
+
+---
+
+## ๐ Ready to Get Started?
+
+
+
+**Choose your path:**
+
+### ๐ **For Homeowners**
+Try the [Quick Start](#-quick-start-5-minutes) guide above and start saving on your energy bills today!
+
+### ๐จโ๐ป **For Developers**
+Explore the system components and documentation to start building energy applications.
+
+### ๐๏ธ **For Communities**
+Set up APIS for your neighborhood and bring energy independence to your community.
+
+### ๐ **For Researchers**
+Contribute to the future of distributed energy systems through APIS development and research.
+
+## Code Quality Tooling (Java)
+
+APIS Java modules may use standard code quality tools to keep the codebase
+consistent and modern.
+
+- **Checkstyle** is used to enforce Java coding conventions.
+- **Modernizer** helps detect usage of legacy Java APIs.
+- **OpenRewrite** can assist with automated refactoring and modernization.
+
+Configuration for these tools is typically done through Maven (`pom.xml`)
+and may vary between modules.
+---
+
+*Made with โค๏ธ by the APIS Community - Powering the future, one battery at a time.*
diff --git a/runner.sh b/runner.sh
index cfbcc85..1be3a58 100644
--- a/runner.sh
+++ b/runner.sh
@@ -21,9 +21,9 @@ elif [ "$UNAME" = 'Linux' ] ; then
#gnome-terminal --working-directory=$DIR -- bash -c "$COMMAND; bash"
gnome-terminal -- bash -c "cd $DIR && $COMMAND; bash"
elif type konsole > /dev/null 2>&1 ; then
- konsole --hold -e "cd $DIR && $COMMAND" &
+ konsole --hold -e bash -c "cd $DIR && $COMMAND; bash" &
elif type xfce4-terminal > /dev/null 2>&1 ; then
- xfce4-terminal --hold -e "cd $DIR && $COMMAND" &
+ xfce4-terminal --hold -e "bash -c 'cd $DIR && $COMMAND; bash'" &
elif type xterm > /dev/null 2>&1 ; then
xterm -hold -e "cd $DIR && $COMMAND" &
else