diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..bbe4b6f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug, help wanted, invalid, question +assignees: Avinash24R + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..f4a99fc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: Bug +labels: bug, help wanted, invalid, question, wontfix +assignees: Avinash24R + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..fad0bf7 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +avinash24082005@gmail.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2fdf7a9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,83 @@ +# Contributing to Smart Microgrid System + +Thank you for your interest in contributing to the **Smart Microgrid System** project! +Your contributionsβwhether code, documentation, bug reports, or suggestionsβhelp us improve the system for smarter energy management. + +--- + +## π How to Contribute + +### π Reporting Issues +- Check the **Issues** tab to see if your issue already exists. +- If not, create a **new issue** with: + - Clear and descriptive title + - Steps to reproduce the problem + - Expected vs actual behavior + - Screenshots or logs (if applicable) + +--- + +### π‘ Suggesting Features +- Open a new issue under the **Feature Request** label. +- Describe: + - The feature name + - Why itβs needed + - How it improves the system + +--- + +### π οΈ Submitting Code +1. **Fork the repository** +2. **Clone your fork** + ```bash + git clone https://github.com/yourusername/Smart_Microgrid_System.git + + cd Smart_Microgrid_System + + pip install -r requirements.txt + ``` +3. Make changes in the proper directories: + +- website/ β HTML, CSS, JS changes , Dockerfile + +- tests/ β Add or update tests + +- mobile_app/ β Frontend , Backend , Dockerfile , docker-compose.yml + +4. Run tests before commiting + ```bash + pytest -v + ``` +5. Commit with a clear message + ```bash + git add . + git commit -m "Add feature: describe your change" + ``` +6.Push to your branch + ```bash + git push origin feature/my-new-feature + ``` +7. Open a pull request +- Provide a clear description of your changes + +- Link related issues if applicable +--- + +###π Code Style + +- Use consistent indentation (2 or 4 spaces). + +- Write descriptive variable and function names. + +- Keep CSS/JS organized inside website/styles/ and website/scripts/. + +- Update or add tests for any new functionality. +--- + +### π Review Process + +- PRs will be reviewed by maintainers. + +- Changes may be requested before merging. + +- Always pull the latest changes from dev before starting work. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..f2e34ea --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,44 @@ +# π Security Policy + +## Supported Versions +We release patches for security vulnerabilities in the following versions of the Smart Microgrid System: + +| Version | Supported | +|---------|------------| +| main (latest) | β | +| dev branch | β | +| older versions | β | + +Please always update to the latest version for the best security. + +--- + +## Reporting a Vulnerability +If you discover a security vulnerability, **please do not create a public GitHub issue.** + +Instead, report it responsibly by: + +- Emailing us at: *avinash24082005@gmail.com** +- Or contacting the maintainers directly via GitHub + +We will investigate and respond as quickly as possible. + +--- + +## Guidelines for Responsible Disclosure +- Provide detailed steps to reproduce the vulnerability (if possible). +- Do not exploit the vulnerability beyond what is necessary to demonstrate the issue. +- Do not share details of the vulnerability publicly until it is fixed. +- We will acknowledge your report, keep you updated, and credit you if desired. + +--- + +## Security Best Practices for Contributors +- Keep your dependencies updated (`pip install -r requirements.txt --upgrade`). +- Do not commit secrets, passwords, or API keys. +- Follow the [Contribution Guidelines](CONTRIBUTING.md). +- Run tests locally before opening a PR. + +--- + +β By working together, we ensure the Smart Microgrid System remains safe and reliable for everyone. diff --git a/mobile_app/.gitkeep b/mobile_app/.gitkeep new file mode 100644 index 0000000..49cc8ef Binary files /dev/null and b/mobile_app/.gitkeep differ diff --git a/tests/test_file_structure.py b/tests/test_file_structure.py new file mode 100644 index 0000000..b9efa8f --- /dev/null +++ b/tests/test_file_structure.py @@ -0,0 +1,41 @@ +import os +import pytest + +PROJECT_ROOT = os.path.abspath( + os.path.join(os.path.dirname(__file__), "..") + ) + + +EXPECTED_DIRS = [ + ".github", + # "mobile_app", + "website", + "tests", +] + +EXPECTED_FILES = [ + "README.md", + "requirements.txt", + "CONTRIBUTING.md", + "CODE_OF_CONDUCT.md", + "SECURITY.md", + "LICENSE", + os.path.join(".github", "workflows", "ci.yml"), + +] + + + +def test_required_directories_exist(): + for d in EXPECTED_DIRS: + path = os.path.join(PROJECT_ROOT, d) + assert os.path.isdir(path), f"β Missing required directory: {d}" + +def test_required_files_exist(): + for f in EXPECTED_FILES: + path = os.path.join(PROJECT_ROOT, f) + assert os.path.isfile(path), f"β Missing required file: {f}" + +def test_git_initialized(): + git_dir = os.path.join(PROJECT_ROOT, ".git") + assert os.path.isdir(git_dir), "β Git is not initialized in Smart_Microgrid_System/" \ No newline at end of file diff --git a/website/README.md b/website/README.md index 31635cf..696c378 100644 --- a/website/README.md +++ b/website/README.md @@ -56,6 +56,7 @@ docker run -d -p 8080:80 my-website ``` ### π Project Structure +```text website/ βββ index.html # Homepage βββ problem.html # Problem Statement page @@ -63,4 +64,5 @@ website/ βββ styles.css # Stylesheet βββ script.js # JavaScript logic βββ Dockerfile # Docker build instructions -βββ docker-compose.yml # Compose configuration \ No newline at end of file +βββ docker-compose.yml # Compose configuration +``` \ No newline at end of file diff --git a/website/assets/dev_img/avinash_r_img.jpg b/website/assets/dev_img/avinash_r_img.jpg new file mode 100644 index 0000000..c6d8f52 Binary files /dev/null and b/website/assets/dev_img/avinash_r_img.jpg differ diff --git a/website/assets/dev_img/ir_img.jpg b/website/assets/dev_img/ir_img.jpg new file mode 100644 index 0000000..03a8e32 Binary files /dev/null and b/website/assets/dev_img/ir_img.jpg differ diff --git a/website/assets/dev_img/ir_img2.png b/website/assets/dev_img/ir_img2.png new file mode 100644 index 0000000..4180708 Binary files /dev/null and b/website/assets/dev_img/ir_img2.png differ diff --git a/website/assets/dev_img/khushi_ks_img.jpg b/website/assets/dev_img/khushi_ks_img.jpg new file mode 100644 index 0000000..7d3c277 Binary files /dev/null and b/website/assets/dev_img/khushi_ks_img.jpg differ diff --git a/website/assets/dev_img/neno_img.jpg b/website/assets/dev_img/neno_img.jpg new file mode 100644 index 0000000..7bffad9 Binary files /dev/null and b/website/assets/dev_img/neno_img.jpg differ diff --git a/website/assets/dev_img/pritam_sh_img.jpg b/website/assets/dev_img/pritam_sh_img.jpg new file mode 100644 index 0000000..7f09096 Binary files /dev/null and b/website/assets/dev_img/pritam_sh_img.jpg differ diff --git a/website/assets/dev_img/vishal_jg_img.jpg b/website/assets/dev_img/vishal_jg_img.jpg new file mode 100644 index 0000000..dd761b8 Binary files /dev/null and b/website/assets/dev_img/vishal_jg_img.jpg differ diff --git a/website/index.html b/website/index.html index 746a082..7cb3bf1 100644 --- a/website/index.html +++ b/website/index.html @@ -4,7 +4,11 @@
Meet the visionary developers behind this project, passionate about building cutting-edge cloud solutions.
-[Role]
-Flutter designer
-DBMS Manager
-Frontend Developer
-[Role]
-[Role]
-