Skip to content

Latest commit

 

History

History
121 lines (96 loc) · 5.93 KB

README.md

File metadata and controls

121 lines (96 loc) · 5.93 KB

NetAddress Configuration System

Overview

The NetAddress Configuration System is designed to streamline the process of network planning and IP allocation for organizations with multiple branches and departments. This system provides a comprehensive solution for calculating and assigning IP addresses, subnet masks, and other network configurations, minimizing IP wastage while ensuring efficient and effective network management.

Table of Contents

  1. Technologies Used
  2. Key Features
  3. Benefits
  4. Installation
  5. Usage
  6. Future Enhancements
  7. Team Contributions
  8. Developed Report
  9. Acknowledgments
  10. License
  11. Contributing
  12. Security

Technologies Used

The following technologies were used in the development of the NetAddress Configuration System:

  • TypeScript
  • CSS
  • HTML
  • React
  • Vite

Key Features

  • Branch and Department Configuration:

    • Input the number of branches.
    • Specify the department count for each branch.
    • Define the number of users in each department.
  • Automatic Network Calculation:

    • Calculate the related block size per department.
    • Determine the network address, first usable IP, last usable IP, broadcast address, and default gateway for each department.
    • Assign subnet masks with minimal IP wastage for each department.
  • Detailed Reporting:

    • Generate detailed reports displaying all calculated network parameters.
    • Provide IP configuration codes for each department.
    • Offer configuration scripts for routers and devices to facilitate easy setup.

Benefits

  • Efficiency: Streamlines the process of IP address allocation and network configuration, saving time and reducing errors.
  • Scalability: Easily manage network configurations for organizations with multiple branches and departments.
  • Accuracy: Ensures precise IP address calculations and minimal IP wastage.
  • Usability: Provides clear, actionable data and visual aids to simplify network setup and management.

Installation

To install and run the NetAddress Configuration System, follow these steps:

  1. Clone the repository:
    git clone https://github.com/gayanukabulegoda/NetAddress-Configuration-System.git
    
  2. Navigate to the project directory:
    cd NetAddress-Configuration-System
    
  3. Install the required dependencies:
    npm install
    
  4. Start the application:
    npm run dev
     

Usage

  1. Navigate to the home page to input the department name and user count.
  2. Review and verify the entered data in the department detail view popup.
  3. Generate and view the comprehensive IP table for the entire LAN on the IP table view page.

Future Enhancements

Future enhancements for the NetAddress Configuration System include:

  • Expanding the system to support WAN (Wide Area Network) calculations and configuration generation.
  • Developing functionality for creating rough network diagrams for WANs to aid in network planning and development.

Team Contributions

This project is a collaborative effort by the following team members:

  • Gayanuka: Documentation Development / Code Review
  • Lokitha: Calculation Implementation
  • Ashen: UI Implementation
  • Yasith: Resource Finding and Documentation Support
  • Aravinda: UI Design Support and Documentation Support

Developed Report

For a detailed analysis and insights into the project, refer to our developed report.

Acknowledgments

We would like to thank our instructors and peers for their support and guidance throughout the development of this project. Special thanks to the contributors and the open-source community for their invaluable resources and inspiration.

License

This project is licensed under the MIT License - see the MIT License file for details.

Contributing

We welcome contributions to the NetAddress Configuration System. Please see our CONTRIBUTING.md for guidelines on how to contribute.

Security

If you discover any security vulnerabilities, please follow our SECURITY.md guidelines for reporting them.


© 2024 Gayanuka Bulegoda | Janindu Lokitha | Ashen Madhushanka | Aravinda Gamage | Yasith Chathuranga