Skip to content
Merged
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
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--
Copyright (c) 2025 Green Wave Team

This software is released under the MIT License.
https://opensource.org/licenses/MIT
-->
Expand All @@ -12,13 +12,13 @@

### _AI-Powered Traffic Optimization for Cleaner Cities_

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
[![FIWARE](https://img.shields.io/badge/FIWARE-Orion--LD-002E67?style=for-the-badge&logo=fiware)](https://www.fiware.org/)
[![Docker](https://img.shields.io/badge/Docker-Ready-2496ED?style=for-the-badge&logo=docker&logoColor=white)](https://www.docker.com/)
<a href="https://opensource.org/licenses/MIT" target="_blank"><img src="https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge" alt="License: MIT"/></a>
<a href="https://www.fiware.org/" target="_blank"><img src="https://img.shields.io/badge/FIWARE-Orion--LD-002E67?style=for-the-badge&logo=fiware" alt="FIWARE"/></a>
<a href="https://www.docker.com/" target="_blank"><img src="https://img.shields.io/badge/Docker-Ready-2496ED?style=for-the-badge&logo=docker&logoColor=white" alt="Docker"/></a>

<br />

[**Documentation**](http://localhost:3000/GreenWave/) β€’ [**Quick Start**](#-quick-start) β€’ [**Architecture**](#-architecture) β€’ [**Features**](#-features)
<a href="https://sonmessia.github.io/GreenWave/" target="_blank"><strong>Documentation</strong></a> β€’ [**Quick Start**](#getting-started) β€’ [**Architecture**](#architecture) β€’ [**Features**](#features)

</div>

Expand Down Expand Up @@ -102,13 +102,13 @@

### Prerequisites

| Requirement | Version | Download |
| :---------- | :------ | :------------------------------------------------- |
| **Docker** | 28.3.2+ | [Get Docker](https://www.docker.com/get-started/) |
| **Node.js** | 24.6.0+ | [Get Node.js](https://nodejs.org/en/download) |
| **SUMO** | 1.25.0+ | [Get SUMO](https://sumo.dlr.de/docs/Downloads.php) |
| Requirement | Version | Download |
| :---------- | :------ | :---------------------------------------------------------------------------- |
| **Docker** | 28.3.2+ | <a href="https://www.docker.com/get-started/" target="_blank">Get Docker</a> |
| **Node.js** | 24.6.0+ | <a href="https://nodejs.org/en/download" target="_blank">Get Node.js</a> |
| **SUMO** | 1.25.0+ | <a href="https://sumo.dlr.de/docs/Downloads.php" target="_blank">Get SUMO</a> |

> **Note:** If you want to run SUMO on your local machine, you need to download and install it from the [SUMO website](https://sumo.dlr.de/docs/Downloads.php).
> **Note:** If you want to run SUMO on your local machine, you need to download and install it from the <a href="https://sumo.dlr.de/docs/Downloads.php" target="_blank">SUMO website</a>.

### πŸƒβ€β™‚οΈ Run the Application

Expand All @@ -121,6 +121,12 @@ git clone https://github.com/sonmessia/GreenWave.git
# Navigate to the project directory
cd GreenWave

# Copy the environment variables
cp .env.example .env

# Navigate to the project directory
cd src/backend

# Copy the environment variables
cp .env.example .env
```
Expand Down Expand Up @@ -190,7 +196,7 @@ Once services are running, access them at:

<div align="center">

### **[Read Full Documentation](https://sonmessia.github.io/GreenWave)**
### <a href="https://sonmessia.github.io/GreenWave" target="_blank"><strong>Read Full Documentation</strong></a>

Explore detailed tutorials, API references, architecture guides, and more!

Expand Down Expand Up @@ -244,4 +250,4 @@ Help us keep GreenWave open and inclusive. Please read and follow our [Code of C

This project is licensed under the terms of the [MIT](LICENSE) license.

</p>
</p>
8 changes: 8 additions & 0 deletions docs/docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,13 @@ cd GreenWave
Copy the example configuration file to the official `.env` file:

```bash
# Copy the environment variables
cp .env.example .env

# Change directory to backend
cd src/backend

# Copy the environment variables
cp .env.example .env
```

Expand All @@ -55,6 +62,7 @@ cp .env.example .env
This is the simplest way to start the whole system:

```bash
# Run docker compose
docker compose up -d
```

Expand Down
7 changes: 7 additions & 0 deletions docs/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,13 @@ Run the following command to start all services (Context Broker, Backend, Fronte

```bash
cp .env.example .env
# Change directory to backend
cd src/backend

# Copy the environment variables
cp .env.example .env

# Run docker compose
docker compose up -d
```

Expand Down
6 changes: 1 addition & 5 deletions src/backend/app/sumo_rl/sumo_files/Nga4ThuDuc/e1_0.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>

<!-- generated on 2025-12-07T15:04:56.440547+00:00 by Eclipse SUMO sumo 1.25.0
<!-- generated on 2025-12-11T06:56:10.263166+00:00 by Eclipse SUMO sumo 1.25.0
<sumoConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://sumo.dlr.de/xsd/sumoConfiguration.xsd">

<input>
Expand All @@ -15,7 +15,3 @@
</traci_server>

</sumoConfiguration>
-->

<detector xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://sumo.dlr.de/xsd/det_e1_file.xsd">
</detector>
6 changes: 1 addition & 5 deletions src/backend/app/sumo_rl/sumo_files/Nga4ThuDuc/e1_1.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>

<!-- generated on 2025-12-07T15:04:56.441018+00:00 by Eclipse SUMO sumo 1.25.0
<!-- generated on 2025-12-11T06:56:10.353502+00:00 by Eclipse SUMO sumo 1.25.0
<sumoConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://sumo.dlr.de/xsd/sumoConfiguration.xsd">

<input>
Expand All @@ -15,7 +15,3 @@
</traci_server>

</sumoConfiguration>
-->

<detector xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://sumo.dlr.de/xsd/det_e1_file.xsd">
</detector>
6 changes: 1 addition & 5 deletions src/backend/app/sumo_rl/sumo_files/Nga4ThuDuc/e1_2.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>

<!-- generated on 2025-12-07T15:04:56.441284+00:00 by Eclipse SUMO sumo 1.25.0
<!-- generated on 2025-12-11T06:56:10.396126+00:00 by Eclipse SUMO sumo 1.25.0
<sumoConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://sumo.dlr.de/xsd/sumoConfiguration.xsd">

<input>
Expand All @@ -15,7 +15,3 @@
</traci_server>

</sumoConfiguration>
-->

<detector xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://sumo.dlr.de/xsd/det_e1_file.xsd">
</detector>
6 changes: 1 addition & 5 deletions src/backend/app/sumo_rl/sumo_files/Nga4ThuDuc/e1_3.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>

<!-- generated on 2025-12-07T15:04:56.441488+00:00 by Eclipse SUMO sumo 1.25.0
<!-- generated on 2025-12-11T06:56:10.442960+00:00 by Eclipse SUMO sumo 1.25.0
<sumoConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://sumo.dlr.de/xsd/sumoConfiguration.xsd">

<input>
Expand All @@ -15,7 +15,3 @@
</traci_server>

</sumoConfiguration>
-->

<detector xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://sumo.dlr.de/xsd/det_e1_file.xsd">
</detector>
6 changes: 1 addition & 5 deletions src/backend/app/sumo_rl/sumo_files/Nga4ThuDuc/e1_4.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>

<!-- generated on 2025-12-07T15:04:56.441686+00:00 by Eclipse SUMO sumo 1.25.0
<!-- generated on 2025-12-11T06:56:10.486557+00:00 by Eclipse SUMO sumo 1.25.0
<sumoConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://sumo.dlr.de/xsd/sumoConfiguration.xsd">

<input>
Expand All @@ -15,7 +15,3 @@
</traci_server>

</sumoConfiguration>
-->

<detector xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://sumo.dlr.de/xsd/det_e1_file.xsd">
</detector>
6 changes: 1 addition & 5 deletions src/backend/app/sumo_rl/sumo_files/Nga4ThuDuc/e1_5.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>

<!-- generated on 2025-12-07T15:04:56.441890+00:00 by Eclipse SUMO sumo 1.25.0
<!-- generated on 2025-12-11T06:56:10.529731+00:00 by Eclipse SUMO sumo 1.25.0
<sumoConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://sumo.dlr.de/xsd/sumoConfiguration.xsd">

<input>
Expand All @@ -15,7 +15,3 @@
</traci_server>

</sumoConfiguration>
-->

<detector xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://sumo.dlr.de/xsd/det_e1_file.xsd">
</detector>
6 changes: 1 addition & 5 deletions src/backend/app/sumo_rl/sumo_files/Nga4ThuDuc/e1i_0.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>

<!-- generated on 2025-12-07T15:04:56.442079+00:00 by Eclipse SUMO sumo 1.25.0
<!-- generated on 2025-12-11T06:56:10.559992+00:00 by Eclipse SUMO sumo 1.25.0
<sumoConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://sumo.dlr.de/xsd/sumoConfiguration.xsd">

<input>
Expand All @@ -15,7 +15,3 @@
</traci_server>

</sumoConfiguration>
-->

<instantE1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://sumo.dlr.de/xsd/instant_e1_file.xsd">
</instantE1>
6 changes: 1 addition & 5 deletions src/backend/app/sumo_rl/sumo_files/Nga4ThuDuc/e1i_1.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>

<!-- generated on 2025-12-07T15:04:56.442320+00:00 by Eclipse SUMO sumo 1.25.0
<!-- generated on 2025-12-11T06:56:10.595247+00:00 by Eclipse SUMO sumo 1.25.0
<sumoConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://sumo.dlr.de/xsd/sumoConfiguration.xsd">

<input>
Expand All @@ -15,7 +15,3 @@
</traci_server>

</sumoConfiguration>
-->

<instantE1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://sumo.dlr.de/xsd/instant_e1_file.xsd">
</instantE1>
Loading
Loading