Site Inspector

This Site Inspection Web App is designed to facilitate telecommunications site inspections by providing a robust, customizable platform for technicians and managers. Built with Node.js, Express.js, EJS, MySQL, and Bootstrap, it enables efficient site inspections, comprehensive logging, and detailed reporting.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

• Technician Inspections: Technicians can perform site inspections with predefined checklist items, observing and evaluating each item efficiently.
• Inspection Logging: All inspections are logged systematically, allowing for easy tracking and historical reference.
• Manager Overview: Managers have access to an overview of all sites, with the ability to generate detailed reports on inspections and site status.
• Customizable Checklists: The platform supports customizable checklist items, enabling flexibility to adapt to various inspection requirements.
• Dynamic Site Information: Managers and technicians can add and manage different types of information about sites, tailoring the system to specific needs.
• Custom Task Scheduling: Custom tasks can be scheduled and performed, ensuring all site-related activities are tracked and managed effectively.

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

List of software and how to install them.

• npm

  npm install npm@latest -g

• MySQL Server

Installation

To get started with the Site Inspection Web App, follow these steps:

1. Clone the repo

   git clone https://github.com/mason-ford/site-inspection.git

2. Install NPM packages

   npm install

3. Set up the database:

   • Ensure you have MySQL installed and running.
   • Create a new database for the project.
   • Import the example database in database/site_inspector.sql
   • Update the database configuration in database/mysql.js with your MySQL credentials.

(back to top)

Usage

• Technicians: Log in to perform inspections, fill out checklists, and submit reports.
• Managers: Log in to view site overviews, manage checklists, schedule tasks, and generate comprehensive reports.

(back to top)

Roadmap

• Secure authentication and user handling

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Mason Ford - [email protected]

Project Link - https://github.com/mason-ford/site-inspection

(back to top)