Skip to content

docs: add documentation for the examples #288

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.

Sign up for GitHub

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

Merged
Manuel-Pol merged 3 commits into from
Jun 30, 2025
Merged

docs: add documentation for the examples #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c233b60
docs: add mention of the examples
MegaRedHand Jun 28, 2025
c56f252
docs: add a readme on the examples folder
MegaRedHand Jun 28, 2025
0079c79
Merge branch 'main' into example-documentation
Manuel-Pol Jun 30, 2025
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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ You can access it [here](https://megaredhand.github.io/network-simulator/).
- [GEduNet 🌐](#gedunet-)
- [**GEduNet - User Manual** 📘](#gedunet---user-manual-)
- [Getting Started](#getting-started)
- [User Interface](#user-interface)
- [Left Bar](#left-bar)
- [Right Bar](#right-bar)
- [Top Bar](#top-bar)
Expand Down Expand Up @@ -62,6 +63,11 @@ You can access it [here](https://megaredhand.github.io/network-simulator/).

Welcome to the GEduNet simulator! This application is designed to help you visualize and understand computer networks.

This repository includes some examples under `examples/`.
You can download and load them into the simulator like any other network.

## User Interface

GEduNet consists of 4 main components on screen:

1. Right bar: Shows information about the selected device.
Expand Down
28 changes: 28 additions & 0 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Examples

This directory has some example networks ready to be loaded into the simulator.
We also include some information on each example here.

## [HTTP Client-Server](./httpClientServer.json)

This example includes three hosts and two routers, simulating a server and multiple clients that communicate through the internet.
To see it in action, run the HTTP request program in one of the clients, selecting the HTTP server as the destination.

## [Local network](./localNetwork.json)

This example includes three hosts connected by a single switch, simulating a local area network.
A good place to check how ARP requests work!

## [Misconfigured router](./misconfiguredRouter.json)

This example includes two hosts connected through a loop of three routers.
One of the hosts is running the "Echo server" program, which regularly sends ICMP echo packets.
However, the packets don't ever reach the other host, since one of the router's routing tables is misconfigured.
The routing table entry for the receiving host instead points to the next router on the loop, causing the packet to be forever lost in the network.
After a while, the packets are dropped due to their TTL decreasing to zero.

## [Subnetting](./subnetting.json)

This example includes multiple hosts, routers, and switches.
Each host represents a group of hosts, shown in their tags.
It was inspired by an exercise on subnet partitioning and routing table configuration.