Merge branch 'main' into develop

CODE_OF_CONDUCT.md

@@ -0,0 +1,45 @@
+# Umeme Upo Code of Conduct
+
+## Purpose
+
+The Umeme Upo project is dedicated to providing a safe, inclusive, and welcoming environment for all contributors and participants. This Code of Conduct outlines our expectations and guidelines for behavior within the project.
+
+## Expected Behavior
+
+As a contributor of the Umeme Upo , we expect you to:
+
+- Be respectful and considerate of others.
+- Be inclusive and welcoming, regardless of background, identity, or experience.
+- Choose your words carefully and avoid offensive or disrespectful comments.
+- Listen actively and be open to different perspectives.
+
+## Unacceptable Behavior
+
+Unacceptable behavior includes, but is not limited to:
+
+- Harassment, discrimination, or intimidation in any form.
+- Offensive or inappropriate comments, gestures, or images.
+- Disruptive behavior in any project spaces, online or offline.
+- Any form of unwelcome sexual attention or advances.
+
+## Reporting and Enforcement
+
+If you witness or experience behavior that violates this Code of Conduct, please report it promptly to [contact person or email].
+
+All reports will be treated seriously and responded to promptly. The project maintainers are responsible for enforcing the Code of Conduct, and they have the right to take appropriate corrective action, including the removal of content, banning individuals, or reporting violations to relevant authorities.
+
+## Scope
+
+This Code of Conduct applies to all Umeme Upo project spaces, including but not limited to GitHub repositories, communication channels, and events. It extends to all contributors, maintainers, and participants.
+
+## Acknowledgment
+
+By participating in the Umeme Upo project, you agree to adhere to this Code of Conduct. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, issues, and other contributions that do not align with this Code of Conduct.
+
+## Contact
+
+If you have any concerns, please contact [contact person or email]. All reports will be handled confidentially.
+
+## License and Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html). The Umeme Upo project is committed to fostering an open and inclusive community, and we appreciate your cooperation in ensuring a positive and respectful environment for all.

CONTRIBUTING.md

@@ -0,0 +1,133 @@
+# Umeme Upo Contribution Guide
+
+## Welcome Contributors!
+
+Thank you for considering contributing to Umeme Upo! We appreciate your time and effort to make this project better. Please take a moment to review this document in order to understand how to contribute.
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+  - [Prerequisites](#prerequisites)
+  - [Installation](#installation)
+- [Contributing](#contributing)
+  - [Creating an Issue](#creating-an-issue)
+  - [Working on an Issue](#working-on-an-issue)
+  - [Creating a Branch](#creating-a-branch)
+  - [Making Changes](#making-changes)
+  - [Creating a Pull Request](#creating-a-pull-request)
+- [Code of Conduct](#code-of-conduct)
+
+## Getting Started
+
+### Prerequisites
+
+Before you start contributing, make sure you have the following installed:
+
+- Node version 18.0.0 or higher
+
+### Installation
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/fredygerman/umeme-upo.git
+   cd umeme-upo
+   ```
+
+2. Install project dependencies using pnpm:
+
+```bash
+pnpm install
+```
+
+3. Create a `.env` file using the `.env.example` file as a template:
+
+```bash
+cp .env.example .env
+```
+
+4. Start the development server:
+
+```bash
+pnpm dev
+```
+
+## Contributing
+
+### Creating an Issue
+
+Before you start working on a feature or a bug fix, you should create an issue. This will allow you to get feedback from the maintainers and other contributors before you start working on it.
+
+1. Go to the [issues page](https://github.com/fredygerman/umeme-upo/issues) and click on the "New Issue" button.
+
+2. Select the type of issue you want to create (bug report, feature request, or question).
+
+3. Fill out the form with the required information.
+
+4. Click on the "Submit new issue" button.
+
+### Working on an Issue
+
+1. Go to the [issues page](https://github.com/fredygerman/umeme-upo/issues) and select an issue to work on.
+
+2. Leave a comment on the issue to let others know that you are working on it.
+
+3. Follow the steps in the [Installation](#installation) section to set up the project.
+
+4. Follow the steps in the [Creating a Branch](#creating-a-branch) section to create a branch for your changes.
+
+5. Follow the steps in the [Making Changes](#making-changes) section to make changes to the codebase.
+
+6. Follow the steps in the [Creating a Pull Request](#creating-a-pull-request) section to create a pull request.
+
+### Creating a Branch
+
+1.  Make sure you are on the `develop` branch:
+
+    ```bash
+    git checkout develop
+    ```
+
+2.  Create a new branch:
+    `bash
+    git checkout -b <username>/feature/<feature-name>
+    `
+
+3.  Push the branch to GitHub:
+
+    ```bash
+    git push -u origin <username>/feature/<feature-name>
+    ```
+
+### Making Changes
+
+1. Make sure you are on the branch you created in the [Creating a Branch](#creating-a-branch) section.
+
+2. Make changes to the codebase.
+
+3. Commit your changes:
+
+   ```bash
+   git add .
+   git commit -m "commit message"
+   ```
+
+4. Push your changes to GitHub:
+
+   ```bash
+    git push
+   ```
+
+### Creating a Pull Request
+
+1. Go to the [pull requests page](https://github.com/fredygerman/umeme-upo/pulls) and click on the "New pull request" button.
+
+2. Select the branch you created in the [Creating a Branch](#creating-a-branch) section.
+
+3. Fill out the form with the required information.
+
+4. Click on the "Create pull request" button.
+
+## Code of Conduct
+
+Please read the [Code of Conduct](CODE_OF_CONDUCT.md) before contributing.

LICENCE.MD

@@ -0,0 +1,21 @@
+License
+
+Copyright (c) 2023 Fredy German Mgimba
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,19 +1,22 @@
 # Umeme Upo
 
-A Next Js app that shows you the current power status of your area.
+A Next Js app that shows you the current power status of various areas in Dar es Salaam, Tanzania.
+
+There are 2 main repositories for this project:
+
+- [Umeme Upo](https://github.com/fredygerman/umeme-upo) - The Next Js App
+- [Umeme Upo Esp32-ping](https://github.com/fredygerman/umeme-upo-esp32-ping) - The ESP32 code that pings my server to notify that the power is on at the location it is.
 
 ## Features
 
-- [🚧] Theme Switcher
-- [🚧] Shows you the current power status of your area.
-- [🚧] Change Area to view power status.
-- [ 🔜] Shows the next power status update time.
-- [ 🔜] Shows the last power status update time.
-- [ 🔜] Funny / Not so Funny Quotes
+- [✅] Theme Switcher
+- [✅] Shows you the current power status of your area.
+- [✅] Change Area to view power status.
+- [✅] Shows the last time the power check was done
+- [✅] Funny / Not so Funny Quotes
 - [ 🔜] Share power status on social media
 - [ 🔜] Share Quotes on social media.
-- [ 🔜] Shows the current time.
-- [ 🔜] Check Status Button
+- [ 🔜] On Demand Power Check Status Button
 - [ 🔜] Realtime Power Status Update
 
 Later On:
@@ -57,7 +60,7 @@ The Directus Flow pings my Home Assistant instance Ip address to check if it is
 - Typescript
 - Tailwind CSS
 - Directus (my headless CMS)
-- Home Assistant (my Smart Home server)
+- ESP32 device to ping my Directus Server
 - Vercel (Hosting)
 
 IF you need help setting up everything with your own instance of Directus, Home Assistant or Vercel, please open an issue or contact me on [@fredygerman\_](https://twitter.com/fredygerman_)
@@ -67,6 +70,12 @@ IF you need help setting up everything with your own instance of Directus, Home
 If you want to contribute to this project, please open an issue.
 Areas that need help:
 
-- [ ] Design (UI/UX improvements)
-- [ ] Suggestions (new features)
-- [ ] Support for more areas (currently only supports Makumbusho, i need ip addresses to ping for other areas)
+Visit the [Contributing Guidelines](https://github.com/fredygerman/umeme-upo/blob/main/CONTRIBUTING.md) for more information.
+
+## Code of Conduct
+
+Visit the [Code of Conduct](https://github.com/fredygerman/umeme-upo/blob/main/CODE_OF_CONDUCT.md) for more information.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/fredygerman/umeme-upo/blob/main/LICENSE) file for details.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "Umeme Upo",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "private": true,
   "scripts": {
     "dev": "next dev",