Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 34 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,12 @@
<img src="./readme/demo/Diagrams/ERD.png"/>
</center>

### System Architect Diagram
### Component Diagram

<center>
<img src="./readme/demo/Diagrams/System Architect Diagram.png"/>
<img src="./readme/demo/Diagrams/Component Diagram Light.png"/>
</center>

### Project Box Design

This box is a demostration of a power room that contain elecrical wire lines and the microcontroller is connected to the circuit.

I used for this project ESP32 DevKit V1. It is based on the ESP32 microcontroller that boasts Wifi, Bluetooth, Ethernet and Low Power support all in a single chip.

| Power Box 1 | Power Box 2 | Power Box 3 |
| --------------------------------------- | ------------------------------------- | ------------------------------------- |
| ![PowerBox](./readme/demo/Project_Box/Power_Room_1.jpg) | ![PowerBox](./readme/demo/Project_Box/Power_Room_2.jpg) | ![PowerBox](./readme/demo/Project_Box/Power_Room_3.jpg) |

<br><br>

<!-- Project Highlights -->
Expand All @@ -49,7 +39,7 @@ I used for this project ESP32 DevKit V1. It is based on the ESP32 microcontrolle

- <b>Personalized AI Optimization Plans:</b> Clients receive intelligent, data-driven strategies to optimize energy usage, reduce costs, and promote sustainability based on their consumption behaviors.

### Remarkable Features
### Features Highlight

<center>
<img src="./readme/demo/Highlights/Highlight Section.png"/>
Expand All @@ -60,34 +50,49 @@ I used for this project ESP32 DevKit V1. It is based on the ESP32 microcontrolle
<!-- Demo -->
<img src="./readme/title5.svg"/>

### Client Screens (Web)
### Landing Screens

| Login screen | Register screen |
| Landing Screen | Login screen |
| --------------------------------------- | ------------------------------------- |
| ![Landing](./readme/demo/1440x1024.png) | ![fsdaf](./readme/demo/1440x1024.png) |
| ![Landing](./readme/demo/Landing/Landing%20Page.gif) | ![Login](./readme/demo/Landing/Login.gif) |

### Client Screens


### Provider Screens (Web)

| Login screen | Register screen |
| Client Dashboard screen | Client Report screen |
| --------------------------------------- | ------------------------------------- |
| ![Landing](./readme/demo/1440x1024.png) | ![fsdaf](./readme/demo/1440x1024.png) |
| ![ClientDashboard](./readme/demo/Client/Client%20Dashboard.gif) | ![ClientReport](./readme/demo/Client/Client%20Report.gif) |

| Client Profile screen |
| --------------------------------------- |
| ![ClientProfile](./readme/demo/Client/Client_Profile.png) |


### Admin Screens (Web)
### Provider Screens (Web)

| Login screen | Register screen |
| Provider Dashboard screen | Provider Report screen |
| --------------------------------------- | ------------------------------------- |
| ![Landing](./readme/demo/1440x1024.png) | ![fsdaf](./readme/demo/1440x1024.png) |
| ![ProviderDashboard](./readme/demo/Provider/Provider%20Dashboard.gif) | ![ProviderReport](./readme/demo/Provider/Provider%20Report.gif) |

| Provider Show Users screen | Provider Edit Profile screen |
| --------------------------------------- | ------------------------------------- |
| ![ProviderUsers](./readme/demo/Provider/Provider_Users.png) | ![ProviderProfile](./readme/demo/Provider/Provider_Profile.png) |


<br><br>

<!-- Development & Testing -->
<img src="./readme/title6.svg"/>

### Project Box Design

This box is a demostration of a power room that contain elecrical wire lines and the microcontroller is connected to the circuit.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (typo): Multiple typos and grammatical error in sentence.

Change 'demostration' to 'demonstration', 'contain' to 'contains', and 'elecrical' to 'electrical'. Also, rephrase 'electrical wire lines' to 'electrical wiring' or 'electrical lines'.

Suggested change
This box is a demostration of a power room that contain elecrical wire lines and the microcontroller is connected to the circuit.
This box is a demonstration of a power room that contains electrical wiring, and the microcontroller is connected to the circuit.


I used for this project ESP32 DevKit V1. It is based on the ESP32 microcontroller that boasts Wifi, Bluetooth, Ethernet and Low Power support all in a single chip.

| Power Box 1 | Power Box 2 | Power Box 3 |
| --------------------------------------- | ------------------------------------- | ------------------------------------- |
| ![PowerBox](./readme/demo/Project_Box/Power_Room_1.jpg) | ![PowerBox](./readme/demo/Project_Box/Power_Room_2.jpg) | ![PowerBox](./readme/demo/Project_Box/Power_Room_3.jpg) |

#### Postman API Documentation

- You can check the full API documentation using this [link](https://documenter.getpostman.com/view/42830816/2sB2qXji4H).
Expand Down Expand Up @@ -154,6 +159,11 @@ I used for this project ESP32 DevKit V1. It is based on the ESP32 microcontrolle
| --------------------------------------- | ------------------------------------- | ------------------------------------- |
| ![PipelineSample](./readme/demo/Deployment/Deployment%20Pipeline%201.png) | ![PipelineSuccess](./readme/demo/Deployment/GitHub_Deploy_Staging_Pipeline.png) | ![EC2Deployed](./readme/demo/Deployment/Node_Server_Docker_Deployed.png) |


| AWS S3 Bucket React files | S3 bucket public IP website |
| --------------------------------------- | ------------------------------------- |
| ![Landing](./readme/demo/Deployment/S3_React_Deployed.png) | ![fsdaf](./readme/demo/Deployment/S3_Website_Deployed.png) |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: Placeholder and non-descriptive alt texts for deployment images.

Change the second image’s alt text (fsdaf) to a descriptive label (e.g., “S3 Deployed Website”) and refine the first image’s alt text (Landing) to clearly convey the React files in the AWS S3 bucket (e.g., “AWS S3 Bucket React Files”).


<br>

#### To test the website, here are some initial default data stored in the database:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,14 @@ const AdminSidebar = () => {
</Link>
</div>
<nav className="sidebar-nav">
<Link to="/admin/navigation-page" className="sidebar-link">
<FontAwesomeIcon icon={faFileAlt} className="sidebar-icon" />
<span className="link-text">Navigation Page</span>
<Link to="/admin/view-providers" className="sidebar-link">
<FontAwesomeIcon icon={faEye} className="sidebar-icon" />
<span className="link-text">View Providers</span>
</Link>
<Link to="/admin/edit-provider" className="sidebar-link">
<FontAwesomeIcon icon={faUserEdit} className="sidebar-icon" />
<span className="link-text">Edit Provider</span>
</Link>
<Link to="/admin/view-providers" className="sidebar-link">
<FontAwesomeIcon icon={faEye} className="sidebar-icon" />
<span className="link-text">View Providers</span>
</Link>
<Link to="/admin/contact-messages" className="sidebar-link">
<FontAwesomeIcon icon={faEnvelope} className="sidebar-icon" />
<span className="link-text">Contact Messages</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
margin: auto;
border-radius: 12px;
margin-top: 30px;
margin-left: 300px;
margin-left: 400px;
}

.provider-header {
Expand Down
Binary file added readme/demo/Client/Client Dashboard.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/demo/Client/Client Report.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/demo/Client/Client_Profile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/demo/Deployment/S3_React_Deployed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/demo/Deployment/S3_Website_Deployed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/demo/Diagrams/Component Diagram Light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/demo/Diagrams/Component Diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file removed readme/demo/Diagrams/System Architect Diagram.png
Binary file not shown.
Binary file modified readme/demo/Highlights/Highlight Section.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/demo/Landing/Landing Page.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/demo/Landing/Login.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/demo/Provider/Provider Dashboard.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/demo/Provider/Provider Report.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/demo/Provider/Provider_Profile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/demo/Provider/Provider_Users.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/demo/Testing/slave_id_index.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/demo/Testing/user_type_indexed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.