21 improve the design

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,17 +1,17 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **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 '....'
@@ -24,15 +24,17 @@ A clear and concise description of what you expected to happen.
 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]
+
+- 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]
+
+- 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.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,10 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Is your feature request related to a problem? Please describe.**

.github/pull_request_template.md

@@ -6,28 +6,28 @@ Please provide a clear and concise description of the changes you are proposing.
 
 If this PR addresses any existing issue(s), please link them here using the format `#<issue_number>`. For example:
 
-*   Fixes #123
-*   Closes #456
-*   Relates to #789
+- Fixes #123
+- Closes #456
+- Relates to #789
 
 ## Proposed Changes
 
 Describe the specific changes you've made. Be as detailed as necessary. For example:
 
-*   Added a new function `foo()` to handle bar operations.
-*   Updated the UI to improve user experience.
-*   Fixed a bug that caused the application to crash under certain conditions.
+- Added a new function `foo()` to handle bar operations.
+- Updated the UI to improve user experience.
+- Fixed a bug that caused the application to crash under certain conditions.
 
 ## Checklist
 
 Please ensure that you have completed the following steps:
 
--   [ ] I have tested these changes thoroughly.
--   [ ] I have updated the documentation (if necessary).
--   [ ] I have added/updated unit tests (if applicable).
--   [ ] I have run `pnpm run lint -- fix` and addressed any linting/formatting issues.
--   [ ] My code follows the project's coding style guidelines.
--   [ ] I have added a changeset if necessary
+- [ ] I have tested these changes thoroughly.
+- [ ] I have updated the documentation (if necessary).
+- [ ] I have added/updated unit tests (if applicable).
+- [ ] I have run `pnpm run lint -- fix` and addressed any linting/formatting issues.
+- [ ] My code follows the project's coding style guidelines.
+- [ ] I have added a changeset if necessary
 
 ## Further Comments
 
@@ -41,10 +41,10 @@ If your changes affect the UI, please include screenshots or GIFs to demonstrate
 
 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
+- [ ] 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
 
 ## Testing instructions
 

CODE_OF_CONDUCT.md

@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
 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,
+- 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
+- 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
+- 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
+- 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
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
@@ -106,7 +106,7 @@ 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
+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

CONTRIBUTING.md

@@ -5,27 +5,31 @@ We're excited you're interested in contributing to the PWA Generator project! We
 ## Getting Started
 
 1.  **Fork the Repository:**
-    *   Visit the PWA Generator repository on GitHub.
-    *   Click the "Fork" button to create your copy of the codebase.
+
+    - Visit the PWA Generator repository on GitHub.
+    - Click the "Fork" button to create your copy of the codebase.
 
 2.  **Clone Your Fork:**
-    *   Open your terminal and use `git clone` to clone your forked repository to your local machine. Replace `<username>` with your GitHub username:
+
+    - Open your terminal and use `git clone` to clone your forked repository to your local machine. Replace `<username>` with your GitHub username:
 
     ```bash
     git clone [https://github.com/](https://github.com/)<username>/pwagenerator.git
     ```
 
 3.  **Install Dependencies (using PNPM):**
-    *   Navigate to your local project directory.
-    *   Install the necessary dependencies using PNPM:
+
+    - Navigate to your local project directory.
+    - Install the necessary dependencies using PNPM:
 
     ```bash
     pnpm install
     ```
 
 4.  **Create a Branch:**
-    *   Use `git checkout -b <branch_name>` to create a new branch for your changes.
-    *   Use a descriptive branch name (e.g., `fix-typo-in-readme`, `add-icon-generation`).
+
+    - Use `git checkout -b <branch_name>` to create a new branch for your changes.
+    - Use a descriptive branch name (e.g., `fix-typo-in-readme`, `add-icon-generation`).
 
     ```bash
     git checkout -b fix-typo-in-readme
@@ -34,11 +38,13 @@ We're excited you're interested in contributing to the PWA Generator project! We
 ## Making Changes
 
 1.  **Work on Your Changes:**
-    *   Make your modifications to the codebase.
-    *   Follow the project's coding style guidelines (if any).
+
+    - Make your modifications to the codebase.
+    - Follow the project's coding style guidelines (if any).
 
 2.  **Linting and Formatting:**
-    *   Before committing, ensure your code passes linting and formatting checks. Run the following command:
+
+    - Before committing, ensure your code passes linting and formatting checks. Run the following command:
 
     ```bash
     pnpm run lint -- fix
@@ -47,20 +53,23 @@ We're excited you're interested in contributing to the PWA Generator project! We
     This command will automatically fix most linting and formatting issues. If there are any remaining errors, please address them manually.
 
 3.  **Testing Your Changes:**
-    *   Thoroughly test your changes to ensure they work as expected and don't introduce regressions.
-    *   Consider adding unit tests if applicable.
+
+    - Thoroughly test your changes to ensure they work as expected and don't introduce regressions.
+    - Consider adding unit tests if applicable.
 
 4.  **Committing Your Changes:**
-    *   Stage your changes using `git add <filename>` or `git add .` to stage all changes.
-    *   Commit your changes with a clear and concise message using `git commit -m "<message>"`. Follow conventional commits if possible.
+
+    - Stage your changes using `git add <filename>` or `git add .` to stage all changes.
+    - Commit your changes with a clear and concise message using `git commit -m "<message>"`. Follow conventional commits if possible.
 
     ```bash
     git add .
     git commit -m "fix: Corrected typo in README"
     ```
 
 5.  **Pushing Your Changes:**
-    *   Push your changes to your forked repository:
+
+    - Push your changes to your forked repository:
 
     ```bash
     git push origin <branch_name>
@@ -69,21 +78,22 @@ We're excited you're interested in contributing to the PWA Generator project! We
 ## Creating a Pull Request (PR)
 
 1.  **Open a Pull Request:**
-    *   Visit your forked repository on GitHub and go to the "Pull requests" tab.
-    *   Click "New pull request."
-    *   Select your branch from the "compare" dropdown.
-    *   Provide a clear title and description for your PR, explaining the changes you've made and the problem they solve.
+
+    - Visit your forked repository on GitHub and go to the "Pull requests" tab.
+    - Click "New pull request."
+    - Select your branch from the "compare" dropdown.
+    - Provide a clear title and description for your PR, explaining the changes you've made and the problem they solve.
 
 2.  **Review and Discussion:**
-    *   We'll review your PR and may provide feedback or request changes.
-    *   Be responsive to feedback and willing to make adjustments as needed.
+    - We'll review your PR and may provide feedback or request changes.
+    - Be responsive to feedback and willing to make adjustments as needed.
 
 ## Additional Guidelines
 
-*   **Code Style:** Adhere to the project's coding style guidelines to maintain consistency.
-*   **Documentation:** If your contribution changes functionality or the user interface, update the relevant documentation.
-*   **Communication:** Actively participate in discussions and address questions or feedback promptly.
-*   **Conventional Commits:** We encourage the use of conventional commits for more organized commit history.
+- **Code Style:** Adhere to the project's coding style guidelines to maintain consistency.
+- **Documentation:** If your contribution changes functionality or the user interface, update the relevant documentation.
+- **Communication:** Actively participate in discussions and address questions or feedback promptly.
+- **Conventional Commits:** We encourage the use of conventional commits for more organized commit history.
 
 ## Thank You!
 

README.md

@@ -12,12 +12,12 @@ Live Demo: [https://pwagenerator.netlify.app](https://pwagenerator.netlify.app)
 
 Here's a breakdown of the current and planned features:
 
--   **Generate Manifest ⚠️:** Creates a fundamental `manifest.json` file, defining essential app metadata such as name, icons (placeholder support), display mode, and start URL. This provides the basic information needed for your PWA to be installable.
--   **Generate Service Worker ⚠️:** Generates a basic service worker script (`service-worker.js`) to enable offline caching and handle basic fetch events. This lays the groundwork for offline functionality and future enhancements like push notifications.
--   **Generate Icons ⏳:** Coming soon! This feature will empower you to effortlessly generate app icons in various sizes and formats, ensuring optimal display across different devices and platforms.
--   **Offline Support ⏳:** Under development! This will enhance the service worker functionality to provide robust offline access to your web application's core content and assets.
--   **IndexedDB Integration ⏳:** Planned for future updates. This will enable your PWA to store structured data locally on the user's device, enabling richer offline experiences and data persistence.
--   **Push Notifications ⏳:** On the roadmap! This exciting feature will allow you to engage users with timely updates and notifications, even when they're not actively using your PWA.
+- **Generate Manifest ⚠️:** Creates a fundamental `manifest.json` file, defining essential app metadata such as name, icons (placeholder support), display mode, and start URL. This provides the basic information needed for your PWA to be installable.
+- **Generate Service Worker ⚠️:** Generates a basic service worker script (`service-worker.js`) to enable offline caching and handle basic fetch events. This lays the groundwork for offline functionality and future enhancements like push notifications.
+- **Generate Icons ⏳:** Coming soon! This feature will empower you to effortlessly generate app icons in various sizes and formats, ensuring optimal display across different devices and platforms.
+- **Offline Support ⏳:** Under development! This will enhance the service worker functionality to provide robust offline access to your web application's core content and assets.
+- **IndexedDB Integration ⏳:** Planned for future updates. This will enable your PWA to store structured data locally on the user's device, enabling richer offline experiences and data persistence.
+- **Push Notifications ⏳:** On the roadmap! This exciting feature will allow you to engage users with timely updates and notifications, even when they're not actively using your PWA.
 
 ## Getting Started
 
@@ -36,10 +36,10 @@ We are planning to open-source this project in the near future. We welcome contr
 
 We are continuously working to improve the PWA Generator. Here's a glimpse of what's on our roadmap:
 
-*   More comprehensive manifest options (e.g., background color, theme color, related applications).
-*   Advanced service worker features (e.g., precaching, background sync, push notifications).
-*   Improved UI/UX for a more seamless user experience.
-*   More detailed documentation and examples.
+- More comprehensive manifest options (e.g., background color, theme color, related applications).
+- Advanced service worker features (e.g., precaching, background sync, push notifications).
+- Improved UI/UX for a more seamless user experience.
+- More detailed documentation and examples.
 
 ## Show Your Support
 

SECURITY.md

@@ -16,21 +16,21 @@ To report a vulnerability, please follow these steps:
 
 2.  **Information to Include:** In your report, please provide the following information to help us understand and reproduce the vulnerability:
 
-    *   **Description of the vulnerability:** A clear and concise explanation of the security issue.
-    *   **Steps to reproduce:** Detailed steps on how to reproduce the vulnerability. This may include specific input values, configurations, or actions.
-    *   **Affected versions:** The specific version(s) of PWA Generator affected by the vulnerability.
-    *   **Potential impact:** A description of the potential impact of the vulnerability, including any possible consequences for users.
-    *   **Proof of concept (if available):** If possible, provide a proof-of-concept exploit or demonstration of the vulnerability. This can significantly aid in our investigation.
+    - **Description of the vulnerability:** A clear and concise explanation of the security issue.
+    - **Steps to reproduce:** Detailed steps on how to reproduce the vulnerability. This may include specific input values, configurations, or actions.
+    - **Affected versions:** The specific version(s) of PWA Generator affected by the vulnerability.
+    - **Potential impact:** A description of the potential impact of the vulnerability, including any possible consequences for users.
+    - **Proof of concept (if available):** If possible, provide a proof-of-concept exploit or demonstration of the vulnerability. This can significantly aid in our investigation.
 
 3.  **Our Response:** We will acknowledge receipt of your report within [Number] business days and will work to investigate and address the vulnerability as quickly as possible. We will keep you updated on our progress.
 
 ## Responsible Disclosure
 
 We encourage responsible disclosure of security vulnerabilities. This means:
 
-*   **Private reporting:** Reporting the vulnerability to us privately first.
-*   **Giving us reasonable time to respond:** Allowing us a reasonable timeframe to investigate and address the vulnerability before public disclosure.
-*   **Avoiding public disclosure before a fix is available:** Refraining from publicly disclosing the vulnerability until a fix has been released or we have provided a coordinated disclosure plan.
+- **Private reporting:** Reporting the vulnerability to us privately first.
+- **Giving us reasonable time to respond:** Allowing us a reasonable timeframe to investigate and address the vulnerability before public disclosure.
+- **Avoiding public disclosure before a fix is available:** Refraining from publicly disclosing the vulnerability until a fix has been released or we have provided a coordinated disclosure plan.
 
 ## Scope
 
@@ -40,11 +40,11 @@ This security policy applies to the PWA Generator project itself, including the
 
 The following are considered out of scope for this security policy:
 
-*   Vulnerabilities in third-party dependencies (unless they directly impact PWA Generator).
-*   Social engineering attacks.
-*   Denial-of-service (DoS) attacks against our infrastructure (unless they exploit a specific vulnerability in PWA Generator).
-*   Issues that do not have a direct security impact.
-*   Best practices violations without clear security implications.
+- Vulnerabilities in third-party dependencies (unless they directly impact PWA Generator).
+- Social engineering attacks.
+- Denial-of-service (DoS) attacks against our infrastructure (unless they exploit a specific vulnerability in PWA Generator).
+- Issues that do not have a direct security impact.
+- Best practices violations without clear security implications.
 
 ## Rewards/Bug Bounties