diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000..e811c57 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,37 @@ +--- +name: Bug +about: "[Bug \U0001F41B]: Create a bug report for Flexify." +title: "[\U0001F41B Bug]: Bug Title." +labels: needs triage +assignees: wiseaidev + +--- + +**👶 Getting Started** +Please [search the history](https://github.com/wiseaidev/flexify/issues) to see if an issue already exists for the same problem. +- [ ] I have searched the existing issues. +- [ ] I have tested the latest version. + +**📝 Describe the bug** +Please provide a summary of what this issue is all about. Thanks for contributing by creating an issue! ❤️ + +**🕹 Steps to reproduce** +Please provide a link to a live example and an unambiguous set of steps to reproduce this bug. You can click the deploy button to provide a live reproduction case. + +Link to live example: +Steps: +1. +2. +3. + +**😯 Current behavior** +A clear and concise description of what you expected to happen. + +**🤔 Expected behavior** +Describe what should happen. + +**📸 Screenshots** +If applicable, add screenshots to help explain your problem. + +**🔦 Additional context** +What are you trying to accomplish? How has this issue affected you? Providing context helps us come up with a solution that is more useful in the real world. diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md new file mode 100644 index 0000000..aabb80a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -0,0 +1,22 @@ +--- +name: feature +about: "[Feature\U0001F484]: Suggest a new idea for Flexify." +title: "[\U0001F484Feature]: Feature title." +labels: needs triage +assignees: wiseaidev + +--- + +**👶 Getting Started** +Please [search the history](https://github.com/wiseaidev/flexify/issues) to see if an issue already exists for the same problem. +- [ ] I have searched the existing issues. +- [ ] I have tested the latest version. + +**📝 Describe the feature** +Please provide a detailed explanation of what this feature is all about. Thanks for contributing by creating an issue! ❤️ + +**📸 Screenshots** +Please provide screenshots of the expected feature, if applicable. + +**🔦 Context** +What are you trying to accomplish? How has the lack of this feature affected you? Providing context helps us come up with a solution that is more useful in the real world. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..95bdfdb --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1 @@ +- [ ] I have followed (at least) the [PR section of the contributing guide](https://github.com/wiseaidev/flexify/blob/main/CONTRIBUTING.md#-pull-request-guidelines). diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..89a9c36 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,13 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" + reviewers: + - "wiseaidev" diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..df4cf71 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# 🌍 Contributing. + +Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. + +## 👶 Getting Started! + +Ready to contribute? Here's how to set up `flexify` for local development. + +1. Fork the `flexify` repo on GitHub. +2. Clone your fork locally: + +```sh +git clone git@github.com:your_name_here/flexify.git +``` + +3. Navigate to the recently created directory: + +```sh +cd flexify +``` + +4. Install the main dependencies: + +```sh +npm install +``` + +5. Create a branch for local development: + +```sh +git checkout -b name-of-your-bugfix-or-feature +``` + +6. Commit your changes and push your branch to GitHub: + +```sh +git add . +git commit -m "Your detailed description of your changes." +git push origin name-of-your-bugfix-or-feature +``` + +7. Submit a pull request through the GitHub website. + +## 📙 Pull Request Guidelines. + +Before you submit a pull request, check that it meets these guidelines: + +1. The pull request should include tests, if applicable. + +Thank you for helping us improve! \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..2f2a26c --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# Flexify + +## Install + +### Chrome + +- Go to chrome extensions page at: `chrome://extensions/`. +- Activate Developer mode. +- Click `Load Unpacked` to install the extension from source folder. + +### Firefox + +- Go to firefox debugging page at: `about:debugging`. +- Click the `This Firefox` hyperlink. +- Click on `load temporary Add-on` to install the extension from source folder. + +## Supported Features + +- Text to speech. +- Text Customization. +- Change contrast, saturation... +- Control the font size of the text on any web page. +- Change text color. +- Change background color. +- Align the whole text to the left, right, or center. +- Adjust text spacing between lines and Letters. + +and many more. + +## License + +This project and the accompanying materials are made available under the terms and conditions of the [`MIT LICENSE`](https://github.com/wiseaidev/flexify/blob/main/LICENSE).