diff --git a/README.md b/README.md index e5167387..7ba93fe3 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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. diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 00000000..64541646 --- /dev/null +++ b/examples/README.md @@ -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.