Merge branch 'main' into docs/database-design

.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md

@@ -3,9 +3,9 @@
 ### Pre-requisites
 
 - [ ] I have gone through the Contributing guidelines for [Submitting a Pull Request (PR)](../../CONTRIBUTING.md#submitting-a-pull-request-pr) and ensured that this is not a duplicate PR.
-- [ ] I have performed preliminary testing using the [test suite](../../apps/api/osmo-notify.postman_collection.json) to ensure that any existing features are not impacted and any new features are working as expected.
+- [ ] I have performed preliminary testing using the [test suite](../../apps/api/OsmoX.postman_collection.json) to ensure that any existing features are not impacted and any new features are working as expected.
 - [ ] I have updated the required [api docs](../../apps/api/docs/) as applicable.
-- [ ] I have added/updated test cases to the [test suite](../../apps/api/osmo-notify.postman_collection.json) as applicable
+- [ ] I have added/updated test cases to the [test suite](../../apps/api/OsmoX.postman_collection.json) as applicable
 
 ### PR Details
 

CONTRIBUTING.md

@@ -1,6 +1,6 @@
-# Contributing to Osmo-Notify
+# Contributing to OsmoX
 
-We would love for you to contribute to Osmo-Notify and help make it even better than it is
+We would love for you to contribute to OsmoX and help make it even better than it is
 today! As a contributor, here are the guidelines we would like you to follow:
 
 <!--* [Code of Conduct](#coc)-->
@@ -15,11 +15,11 @@ today! As a contributor, here are the guidelines we would like you to follow:
   <!-- - [Signing the CLA](#cla) -->
 
 <!-- ## <a name="coc"></a> Code of Conduct
-Help us keep Osmo-Notify open and inclusive. Please read and follow our [Code of Conduct][coc]. -->
+Help us keep OsmoX open and inclusive. Please read and follow our [Code of Conduct][coc]. -->
 
 ## <a name="question"></a> Got a Question or Problem?
 
-**Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests.** You've got much better chances of getting your question answered on [Stack Overflow][stackoverflow] where the questions should be tagged with tag `osmo-notify`.
+**Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests.** You've got much better chances of getting your question answered on [Stack Overflow][stackoverflow] where the questions should be tagged with tag `osmox`.
 
 Stack Overflow is a much better place to ask questions since:
 
@@ -56,7 +56,7 @@ Before you submit an issue, please search the issue tracker, maybe an issue for
 
 We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs we will systematically ask you to provide a minimal reproduction scenario using a repository or [Gist](https://gist.github.com/). Having a live, reproducible scenario gives us wealth of important information without going back & forth to you with additional questions like:
 
-- version of Osmo-Notify used
+- version of OsmoX used
 - 3rd-party libraries and their versions
 - and most importantly - a use-case that fails
 
@@ -79,7 +79,7 @@ Before you submit your Pull Request (PR) consider the following guidelines:
 
 1. Create your patch, **including appropriate test cases**.
 1. Follow our [Coding Rules](#rules).
-1. Run the full Osmo-Notify test suite (see [common scripts](#common-scripts)),
+1. Run the full OsmoX test suite (see [common scripts](#common-scripts)),
    and ensure that all tests pass.
 1. Commit your changes using a descriptive commit message that follows our
    [commit message conventions](#commit). Adherence to these conventions
@@ -97,12 +97,12 @@ Before you submit your Pull Request (PR) consider the following guidelines:
    git push origin my-fix-branch
    ```
 
-1. In GitHub, send a pull request to `osmo-notify:main`.
+1. In GitHub, send a pull request to `osmo-x:main`.
 
 - If we suggest changes then:
 
   - Make the required updates.
-  - Re-run the Osmo-Notify test suites to ensure tests are still passing.
+  - Re-run the OsmoX test suites to ensure tests are still passing.
   - Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
 
     ```shell
@@ -198,7 +198,7 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
 
 We have very precise rules over how our git commit messages can be formatted. This leads to **more
 readable messages** that are easy to follow when looking through the **project history**. But also,
-we use the git commit messages to **generate the Osmo-Notify change log**.
+we use the git commit messages to **generate the OsmoX change log**.
 
 ### Commit Message Format
 
@@ -268,9 +268,9 @@ reference GitHub issues that this commit **Closes**.
 **Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
 
 [commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#
-[github]: https://github.com/OsmosysSoftware/osmo-notify
-[stackoverflow]: https://stackoverflow.com/questions/tagged/osmo-notify
+[github]: https://github.com/OsmosysSoftware/osmo-x
+[stackoverflow]: https://stackoverflow.com/questions/tagged/osmox
 [js-style-guide]: https://airbnb.io/javascript/
-[new_issue]: https://github.com/OsmosysSoftware/osmo-notify/issues/new
-[gh_prs]: https://github.com/OsmosysSoftware/osmo-notify/pulls
-[commits_samples]: https://github.com/OsmosysSoftware/osmo-notify/commits/main
+[new_issue]: https://github.com/OsmosysSoftware/osmo-x/issues/new
+[gh_prs]: https://github.com/OsmosysSoftware/osmo-x/pulls
+[commits_samples]: https://github.com/OsmosysSoftware/osmo-x/commits/main

README.md

@@ -1,8 +1,8 @@
-# Osmo Notify
+# OsmoX
 
-Welcome to the Osmo Notify! 🚀
+Welcome to the OsmoX! 🚀
 
-Are you looking to simplify and streamline your notification process? Our Osmo Notify is here to help! With this user-friendly backend application, you can effortlessly send notifications to various channels like email, messaging apps, and more. It's designed to make communication with your users a breeze!
+Are you looking to simplify and streamline your notification process? Our OsmoX is here to help! With this user-friendly backend application, you can effortlessly send notifications to various channels like email, messaging apps, and more. It's designed to make communication with your users a breeze!
 
 ## What It Does
 
@@ -19,12 +19,12 @@ Imagine having a central hub where you can create and send notifications seamles
 - 🚀 **Single API for All Channels:** Send notifications to various communication channels using a unified API. No need to manage multiple APIs for different platforms.
 - 🔌 **Custom API Integration:** Seamlessly integrate your own custom APIs to push notification data to the database. Our app's cron will handle the rest!
 - 🤖 **Automated Processing:** Sit back and relax as our app processes notification data automatically. No manual intervention required.
-- 💡 **Easy Integration:** Integrate Osmo Notify seamlessly into your existing workflows. Get up and running in no time.
+- 💡 **Easy Integration:** Integrate OsmoX seamlessly into your existing workflows. Get up and running in no time.
 - 🌐 **Multi-channel Support:** Reach your audience wherever they are. Send notifications via email, messaging apps, and more.
 
 ## Components
 
-Osmo Notify is comprised of the following two components:
+OsmoX is comprised of the following two components:
 
 1. [api](apps/api), the backend of the application
 2. [portal](apps/portal), the frontend of the application
@@ -33,7 +33,7 @@ Refer the corresponding README files of these components for more information, s
 
 ## Contributing
 
-We welcome contributions from the community! If you're interested in contributing to the Osmo Notify, please take a moment to review our [Contribution Guidelines](CONTRIBUTING.md).
+We welcome contributions from the community! If you're interested in contributing to the OsmoX, please take a moment to review our [Contribution Guidelines](CONTRIBUTING.md).
 
 Your contributions help make our app even better. Whether you're a developer, designer, or just enthusiastic about enhancing user experiences, we'd love to have you on board.
 
@@ -47,8 +47,8 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 ## 👏 Big Thanks to Our Contributors
 
-<a href="https://github.com/OsmosysSoftware/osmo-notify/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=OsmosysSoftware/osmo-notify" alt="Contributors" />
+<a href="https://github.com/OsmosysSoftware/osmo-x/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=OsmosysSoftware/osmo-x" alt="Contributors" />
 </a>
 
 We appreciate the time and effort put in by all contributors to make this project better!