Netmand

An easy-to-use solution for configuring network devices efficiently and effectively.

Overview • Justification • Usage • Development • Want to Contribute? • Credits

Overview

Netmand is a user-friendly platform that simplifies the configuration of network devices such as PCs, switches, and routers. Users can create comprehensive network designs by selecting and configuring each device's options. Based on these configurations, Netmand generates the necessary commands to set up each device, streamlining the process of network deployment and management.

Justification

The motivation behind creating Netmand stems from the challenges and repetitiveness associated with learning and managing network configurations, particularly in academic settings. Network configuration commands, which are fundamental in networking classes, often tend to be repetitive and easily forgotten, especially when they are not frequently practiced. This can lead to confusion and a steep learning curve for students and newcomers to the field.

Netmand aims to serve as a comprehensive tool that compiles all essential network commands taught in networking courses. By providing an intuitive interface that allows users to design networks and generate configuration commands, Netmand helps in reinforcing learning through practical application. This hands-on approach makes it easier for students to grasp complex concepts and retain critical information.

Additionally, Netmand addresses the issue of consistency in network configuration. By automating the command generation process based on user-selected options, it minimizes errors and ensures that configurations adhere to best practices. This not only aids students but also assists network administrators in quickly setting up and managing network devices, enhancing productivity and reducing the likelihood of misconfigurations.

Development

Alternatively, instead of using the hosted version of the product, Netmand can be run locally for contribution purposes.

Pre-requisites

To be able to start development on Netmand, make sure that you have the following prerequisites installed:

Node.js: You can download and install it from nodejs.org.
Docker: You can download and install it from docker.com.
Git: You can download and install it from git-scm.com.

Running the Project with Docker

If you have Docker installed, you can easily set up and run the project using Docker Compose. Follow these steps:

Clone the repository:

git clone https://github.com/yourusername/netmand.git
cd netmand

Start the Docker containers:
```
docker compose up
```
Access the application: Open your browser and go to http://localhost:8080.

Running the Project without Docker

If you don't have Docker, you can run the project using Node.js. Follow these steps:

Clone the repository:

git clone https://github.com/Torrex123/Netmand
cd netmand

Install the dependencies:
```
npm install
```
Run the application:
```
npm run dev
```
Access the application: Open your browser and go to http://localhost:8080.

Want to Contribute?

This project can still be expanded to include many more functionalities. Here are some potential features that could be added to Netmand:

Serial Port Configuration: Add options to configure serial ports on routers and switches for WAN connections.
New Routing Protocols: Implement support for additional routing protocols such as Static Routes, BGP (Border Gateway Protocol), and OSPF (Open Shortest Path First).
Default Gateways: Allow configuration of default gateways on network devices to ensure proper routing of traffic.
IP Calculators: Integrate IP calculators to help users determine network and broadcast addresses, usable IP ranges, and subnet masks.
Network Simulations: Develop simulation features to test network configurations by sending PDUs (Protocol Data Units) and verifying connectivity between devices.

Credits

The initial version of Netmand has been developed by:

Edgar Andres Torres Pérez: Torrex123
Juan Pablo Vargas Rodríguez: VargasJuanP
Joseph Venegas Banda: venegasbjf
Omar Cifuentes Laverde: OmarCifuentes