Merge branch 'main' into 1-feat-create-frontend-api-to-connect-frontend-and-backend-for-form-templates

juanalvv · web-flow · commit ef58c52072d1 · 2026-02-25T12:45:57.000-08:00
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -0,0 +1,37 @@
+## Description
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+## How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
+
+- [ ] Test A
+- [ ] Test B
+
+**Test Configuration**:
+* Firmware version:
+* Hardware:
+* SDK:
+
+## Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,24 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Álvarez Sánchez"
+  given-names: "Juan"
+- family-names: "Carriedo Garrido"
+  given-names: "Manuel"
+- family-names: "Harkins"
+  given-names: "Vincent"
+- family-names: "Vergés Santiago"
+  given-names: "Marc"
+- family-names: "Sans Domingo"
+  given-names: "Jan"
+title: "FireForm"
+version: 1.0.0
+url: "https://github.com/juanalvv/FireForm"
+abstract: "FireForm is a Digital Public Good (DPG) designed to solve administrative overhead for first responders by automating PDF form filling using AI."
+keywords:
+  - "firefighter"
+  - "first responder"
+  - "AI"
+  - "automated reporting"
+  - "digital public good"
+license: MIT
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,129 @@
+# 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, caste, color, 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 unwelcome sexual attention
+  or advances
+* 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 responsibles.
+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 permanent ban.
+
+### 3. Harassment
+
+**Community Impact**: A serious violation of community standards, including
+sustained harassing behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No unsolicited
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, is allowed. Violating these terms may lead
+to a permanent ban.
+
+### 4. Suspension
+
+**Community Impact**: A violation of community standards that is either
+extremely severe or part of a pattern of behavior.
+
+**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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][faq]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/active-participation/blob/master/Code-of-Conduct-Enforcement-Ladder.md
+[faq]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,50 @@
+# Contributing to FireForm
+
+First of all, thank you for considering contributing to FireForm! It's people like you that make FireForm a great tool for first responders.
+
+FireForm is a Digital Public Good (DPG) designed to reduce administrative overhead for firefighters and other emergency services. By contributing, you are helping us build a more efficient future for emergency response.
+
+>**NOTE: Before you contribute!**
+>Please note that this project is still under early development. Because of this you may find many bugs caused either by cases yet unaddressed that we are aware of. Reports on these bugs will be dismissed to remove clutter, so please don't feel discouraged if your issue is dismissed quickly, it just means we were already aware of the bug.
+
+## 🌈 Code of Conduct
+
+This project and everyone participating in it is governed by the [FireForm Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to juanalvarez_san@protonmail.com.
+
+## 🚀 How Can I Contribute?
+
+### Reporting Bugs
+
+Before creating bug reports, please check the [issues list](https://github.com/juanalvv/FireForm/issues) to see if the problem has already been reported.
+
+When you are creating a bug report, please include as many details as possible:
+* **Use a clear and descriptive title** for the issue to identify the problem.
+* **Use the bug report template** to ensure you include all the necessary information.
+* **Describe the exact steps which reproduce the problem** in as many details as possible.
+* **Explain which behavior you expected to see instead and why.**
+* **Include screenshots** if applicable.
+
+### Suggesting Enhancements
+
+If you have a great idea for FireForm, we'd love to hear it! Please open an issue and include:
+* **A clear and descriptive title.**
+* **A step-by-step description of the suggested enhancement** in as many details as possible.
+* **Explain why this enhancement would be useful** to the users.
+
+### Pull Requests
+
+1. Fork the repo and create your branch from `main`.
+2. If you've added code that should be tested, add tests.
+3. Ensure the test suite passes.
+4. Make sure your code lints.
+5. Issue that pull request!
+
+## 🛠️ Local Development Setup
+
+FireForm uses Docker and Docker Compose for development to ensure a consistent environment.
+
+### Prerequisites
+
+- [Docker](https://docs.docker.com/get-docker/)
+- [Docker Compose](https://docs.docker.com/compose/install/)
+- `make` (optional, but recommended)
diff --git a/README.md b/README.md
@@ -24,13 +24,31 @@ The result is hours of time saved per shift, per firefighter.
 
 Open-Source (DPG): Built 100% with open-source tools to be a true Digital Public Good, freely available for any department to adopt and modify.
 
+## 🤝 Code of Conduct
+
+We are committed to providing a friendly, safe, and welcoming environment for all. Please see our [Code of Conduct](CODE_OF_CONDUCT.md) for more information.
+
+## 🚀 Contributing
+
+Contributions are welcome! Please see our [Contributing Guide](CONTRIBUTING.md) to learn how you can help.
+
 ## ⚖️ License
 
+
+
 This project is licensed under the MIT License. See the LICENSE file for details.
 
 ## 🏆 Acknowledgements and Contributors
 This project was built in 48 hours for the Reboot the Earth 2025 hackathon. Thank you to the United Nations and UC Santa Cruz for hosting this incredible event and inspiring us to build solutions for a better future.
 
+## 📜 Citation
+
+If you use FireForm in your research or project, please cite it using the following metadata:
+
+[![Cite this repository](https://img.shields.io/badge/Cite-FireForm-blue.svg)](CITATION.cff)
+
+You can also use the "Cite this repository" button in the GitHub repository sidebar to export the citation in your preferred format.
+
 __Contributors:__ 
 - Juan Álvarez Sánchez (@juanalvv)
 - Manuel Carriedo Garrido
diff --git a/src/main.py b/src/main.py
@@ -11,7 +11,7 @@ def input_fields(num_fields: int):
         fields.append(field)
     return fields
 
-def run_pdf_fill_process(user_input: str, definitions: list, pdf_form_path: str):
+def run_pdf_fill_process(user_input: str, definitions: list, pdf_form_path: Union[str, os.PathLike]):
     """
     This function is called by the frontend server.
     It receives the raw data, runs the PDF filling logic,
@@ -21,6 +21,9 @@ def run_pdf_fill_process(user_input: str, definitions: list, pdf_form_path: str)
     print("[1] Received request from frontend.")
     print(f"[2] PDF template path: {pdf_form_path}")
     
+    # Normalize Path/PathLike to a plain string for downstream code
+    pdf_form_path = os.fspath(pdf_form_path)
+    
     if not os.path.exists(pdf_form_path):
         print(f"Error: PDF template not found at {pdf_form_path}")
         return None # Or raise an exception
@@ -77,4 +80,4 @@ def run_pdf_fill_process(user_input: str, definitions: list, pdf_form_path: str)
         num_fields = 0
         
     controller = Controller()
-    controller.fill_form(user_input, fields, file)
+    controller.fill_form(user_input, fields, file)
