/room-inspection

Room Inspection App made for African Leadership Academy

Primary LanguageJavaScript

Room Inspection App

The Room Inspection App is designed to streamline the process of evaluating room status at the African Leadership Academy. This app replaces traditional paperwork used by house heads, making the evaluation results easily accessible to students and providing valuable feedback by highlighting the three areas where students received the lowest scores.

Watch Demo

screen-20240527-104833.1.online-video-cutter.com.mp4

Table of Contents

Features

  • Feedback: Offer improvement feedback by highlighting the three lowest-scoring areas.
  • Authentication: Use Firebase for user authentication.
  • Data Storage: Store evaluation scores for every student in Firebase.
  • Monthly Reports: Send monthly reports on overall residential status to relevant administrators.
  • Mobile Accessibility: Build the project into an Android app for convenient use by house heads.

Technologies Used

  • ReactJS: Frontend development.
  • Firebase: Authentication and data storage.
  • EmailJS: Sending monthly reports.
  • Android: Mobile app development.

Getting Started

To get the Room Inspection App up and running on your local machine, follow these steps:

  1. Clone the Repository:

    • Clone this repository to your local machine using the following command: 
      git clone https://github.com/Kaleab-A/room-inspection.git

  2. Install Dependencies:

    • Navigate to the project directory.
    • Install project dependencies by running: 
      npm install

  3. Configure Firebase:

    • Set up a Firebase project and configure the app with Firebase credentials.
    • Update the Firebase configuration in the project.

  4. Run the App:

    • Start the app by running: 
      npm start

  5. Access the App:

    • Open your web browser and visit http://localhost:3000 to access the Room Inspection App.

How It Works

The Room Inspection App simplifies the room evaluation process by automating the following steps:

  1. House heads log in to the app using Firebase authentication.
  2. They perform room inspections for a student and input scores for each criterion based on the rubric.
  3. The app calculates the overall score for the student and stores it in Firebase.
  4. Monthly reports on overall residential status are generated and sent to relevant administrators.
  5. Students can access their evaluation results, including feedback on areas for improvement.