diff --git a/.github/assets/bloggios-header.png b/.github/assets/bloggios-header.png new file mode 100644 index 0000000..28e2e2d Binary files /dev/null and b/.github/assets/bloggios-header.png differ diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..9861698 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,130 @@ +#name: auth-provider-application devsandbox +# +#on: +# push: +# branches: [ "main" ] +# +#jobs: +# build: +# +# runs-on: ubuntu-latest +# permissions: +# contents: read +# packages: write +# +# steps: +# - uses: actions/checkout@v3 +# - name: Set up JDK 17 +# uses: actions/setup-java@v3 +# with: +# java-version: '17' +# distribution: 'temurin' +# server-id: github +# settings-path: ${{ github.workspace }} +# - uses: docker/login-action@v1 +# with: +# username: ${{ secrets.DOCKER_HUB_USERNAME }} +# password: ${{ secrets.DOCKER_HUB_PASSWORD }} +# +# - name: Build with Maven +# run: mvn clean install +# +# - name: Cleaning Docker File +# uses: appleboy/ssh-action@master +# with: +# host: ${{ secrets.V4_HOST }} +# username: ${{ secrets.V4_USERNAME }} +# password: ${{ secrets.V4_VPS_PRIVATE_KEY }} +# port: 22 +# script: | +# cd /root/bloggios-deployment-docker-files +# git stash +# git pull origin main +# +# - name: Cleaning File +# uses: appleboy/ssh-action@master +# with: +# host: ${{ secrets.V4_HOST }} +# username: ${{ secrets.V4_USERNAME }} +# password: ${{ secrets.V4_VPS_PRIVATE_KEY }} +# port: 22 +# script: | +# cd /root/microservices/auth-provider-application +# git stash +# git pull origin main +# +# - name: Add Logback File +# uses: appleboy/ssh-action@master +# with: +# host: ${{ secrets.V4_HOST }} +# username: ${{ secrets.V4_USERNAME }} +# key: ${{ secrets.V4_VPS_PRIVATE_KEY }} +# port: 22 +# script: | +# rm /root/microservices/auth-provider-application/src/main/resources/auth-logback.xml +# cp /root/secrets/logback/auth-logback.xml /root/microservices/auth-provider-application/src/main/resources +# +# - name: Add Keys +# uses: appleby/ssh-action@master +# with: +# host: ${{ secrets.V4_HOST }} +# username: ${{ secrets.V4_USERNAME }} +# key: ${{ secrets.V4_VPS_PRIVATE_KEY }} +# port: 22 +# script: | +# set +e +# rm /root/microservices/auth-provider-application/src/main/resources/security/privkey.pem +# /root/microservices/auth-provider-application/src/main/resources/security/pubkey.pem +# set -e +# cp /root/spring-boot/certificates/privkey.pem /root/microservices/auth-provider-application/src/main/resources/security +# cp /root/spring-boot/certificates/pubkey.pem /root/microservices/auth-provider-application/src/main/resources/security +# +# - name: Stopping Container +# uses: appleboy/ssh-action@master +# with: +# host: ${{ secrets.V4_HOST }} +# username: ${{ secrets.V4_USERNAME }} +# key: ${{ secrets.V4_VPS_PRIVATE_KEY }} +# port: 22 +# script: | +# cd /root/bloggios-deployment-docker-files +# set +e +# docker-compose -f docker-compose-devsandbox.yml stop auth-provider-application +# docker-compose -f docker-compose-devsandbox.yml stop auth-provider-social-application +# docker rmi -f auth-provider-application:1.0 +# set -e +# +# - name: Generating Docker Image +# uses: appleboy/ssh-action@master +# with: +# host: ${{ secrets.V4_HOST }} +# username: ${{ secrets.V4_USERNAME }} +# key: ${{ secrets.V4_VPS_PRIVATE_KEY }} +# port: 22 +# script: | +# cd /root/microservices/auth-provider-application +# chmod +x mvnw +# ./mvnw clean package +# +# - name: Deploy Docker Image +# uses: appleboy/ssh-action@master +# with: +# host: ${{ secrets.V4_HOST }} +# username: ${{ secrets.V4_USERNAME }} +# key: ${{ secrets.V4_VPS_PRIVATE_KEY }} +# port: 22 +# script: | +# cd /root/bloggios-deployment-docker-files +# docker-compose -f docker-compose-devsandbox.yml up -d auth-provider-application +# docker-compose -f docker-compose-devsandbox.yml up -d auth-provider-social-application +# +# - name: Cleaning Targets +# uses: appleboy/ssh-action@master +# with: +# host: ${{ secrets.V4_HOST }} +# username: ${{ secrets.V4_USERNAME }} +# key: ${{ secrets.V4_VPS_PRIVATE_KEY }} +# port: 22 +# script: | +# cd /root/microservices/auth-provider-application +# rm target -r \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..07c7c6c --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,82 @@ +# Bloggios Contributor Covenant Code of Conduct + +## Our Pledge + +We, as members, contributors, and leaders of Bloggios, pledge to cultivate a harassment-free environment for all +participants, irrespective 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 commit to engaging in behaviors that foster an open, welcoming, diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that foster a positive environment within our Bloggios community include: + +- Demonstrating empathy and kindness towards others +- Respecting differing opinions, viewpoints, and experiences +- Giving and graciously accepting constructive feedback +- Taking responsibility for our actions, apologizing to those affected by our mistakes, and learning from these + experiences +- Prioritizing the collective well-being of the community over individual interests + +Examples of unacceptable behavior include: + +- Use of sexualized language or imagery, and any form of sexual attention or advances +- Trolling, making derogatory comments, or engaging in personal or political attacks +- Harassment, whether public or private +- Sharing others' private information, such as physical or email addresses, without explicit permission +- Any other conduct that could reasonably be considered inappropriate in a professional setting + +## Enforcement Responsibilities + +Community leaders within Bloggios are responsible for upholding and enforcing our standards of acceptable behavior. They +will take appropriate and impartial corrective action in response to any behavior deemed inappropriate, threatening, +offensive, or harmful. + +Community leaders reserve the right to remove, edit, or reject comments, commits, code, wiki edits, issues, and other +contributions that do not align with this Code of Conduct. They will communicate the reasons for moderation decisions +when necessary. + +## Scope + +This Code of Conduct applies to all interactions within Bloggios community spaces, as well as when individuals +officially represent the community in public settings. Representation may include the use of an official email address, +posting via official social media accounts, or acting as an appointed representative at online or offline events. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior should be reported to the community leaders +responsible for enforcement at [support@bloggios.com](mailto:support@bloggios.com). All complaints will be promptly +and fairly reviewed and investigated. + +Community leaders are obligated to respect the privacy and security of the individual reporting any incident. + +## Enforcement Guidelines + +Community leaders will adhere to these Enforcement Guidelines in determining consequences for actions violating this +Code of Conduct: + +1. **Correction**: Community Impact - Use of inappropriate language or behavior deemed unprofessional or unwelcome. + + Consequence - A private, written warning from community leaders, offering clarity on the nature of the violation and + an explanation of its inappropriateness. A public apology may be requested. + +2. **Warning**: Community Impact - Violation through a single incident or series of actions. + + Consequence - A warning with repercussions for continued behavior. The individual will have no interaction with the + involved parties, including unsolicited communication with those enforcing the Code of Conduct, for a specified + period. This includes abstaining from interactions in community spaces and external channels like social media. + Violation may result in a temporary or permanent ban. + +3. **Temporary Ban**: Community Impact - Serious violation of community standards, including sustained inappropriate + behavior. + + Consequence - A temporary ban from any interaction or public communication with the community for a specified period. + No public or private interaction with the involved parties is permitted, including unsolicited communication with + those enforcing the Code of Conduct. Violation may lead to a permanent ban. + +4. **Permanent Ban**: Community Impact - Demonstrating a pattern of violating community standards, including sustained + inappropriate behavior, harassment of individuals, or aggression towards or disparagement of classes of individuals. + + Consequence - A permanent ban from Bloggios community participation. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..190eeec --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,202 @@ +# Contributing + +Prior to contributing to this project, we kindly request that you initiate a discussion regarding the proposed change +through an issue on any of our GitHub repository, via email at [email](mailto:support@bloggios.com), or through any +other preferred communication method with the project owners. Your cooperation in this regard is greatly appreciated. + +Please note we have a [Code of Conduct](https://github.com/reactplay/react-play/blob/main/CODE_OF_CONDUCT.md), please +follow it in all your interactions with the project. + +- [Pull Request Process](#prp) +- [Code of Conduct](#coc) +- [Commit Message Format](#commit) + +## Pull Request Process + +This document outlines the guidelines for submitting and approving pull requests (PRs) within the **bloggios_frontend** repository. + +## PR Approval Process + +1. **Dependency Management**: Ensure any install or build dependencies are removed. If holding dependencies is necessary, seek approval from the project owner before finalizing the build. + +2. **Update README**: Update the README.md file with details of changes to the interface, including new environment variables, exposed ports, useful file locations, and container parameters. + +4. **Review and Merge**: You may merge the Pull Request once you have received sign-off from two other developers. If you lack the permissions to merge, request the second reviewer to do so. + +## PR Approval Template + +``` +**This pull request makes the following changes:** +- Fixes issue #[issue-no.]. + +**Checklist:** +- [x] I have created an issue for this solution I am submitting. +- [x] I have created a new branch from the correct branch and made my changes in the new branch created. +- [x] My pull request is sent to the correct base branch in the original repository. +- [x] I have linked the issue I worked on to this pull request. +- [x] File(s) or folder(s) now contain changes as specified in the issue I worked on. +- [x] I certify that I ran my checklist. + +Ping @ +``` + +## Code of Conduct + +## Our Pledge + +We, as members, contributors, and leaders of Bloggios, pledge to cultivate a harassment-free environment for all +participants, irrespective 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 commit to engaging in behaviors that foster an open, welcoming, diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that foster a positive environment within our Bloggios community include: + +- Demonstrating empathy and kindness towards others +- Respecting differing opinions, viewpoints, and experiences +- Giving and graciously accepting constructive feedback +- Taking responsibility for our actions, apologizing to those affected by our mistakes, and learning from these + experiences +- Prioritizing the collective well-being of the community over individual interests + +Examples of unacceptable behavior include: + +- Use of sexualized language or imagery, and any form of sexual attention or advances +- Trolling, making derogatory comments, or engaging in personal or political attacks +- Harassment, whether public or private +- Sharing others' private information, such as physical or email addresses, without explicit permission +- Any other conduct that could reasonably be considered inappropriate in a professional setting + +## Enforcement Responsibilities + +Community leaders within Bloggios are responsible for upholding and enforcing our standards of acceptable behavior. They +will take appropriate and impartial corrective action in response to any behavior deemed inappropriate, threatening, +offensive, or harmful. + +Community leaders reserve the right to remove, edit, or reject comments, commits, code, wiki edits, issues, and other +contributions that do not align with this Code of Conduct. They will communicate the reasons for moderation decisions +when necessary. + +## Scope + +This Code of Conduct applies to all interactions within Bloggios community spaces, as well as when individuals +officially represent the community in public settings. Representation may include the use of an official email address, +posting via official social media accounts, or acting as an appointed representative at online or offline events. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior should be reported to the community leaders +responsible for enforcement at [support@bloggios.com](mailto:support@bloggios.com). All complaints will be promptly +and fairly reviewed and investigated. + +Community leaders are obligated to respect the privacy and security of the individual reporting any incident. + +## Enforcement Guidelines + +Community leaders will adhere to these Enforcement Guidelines in determining consequences for actions violating this +Code of Conduct: + +1. **Correction**: Community Impact - Use of inappropriate language or behavior deemed unprofessional or unwelcome. + + Consequence - A private, written warning from community leaders, offering clarity on the nature of the violation and + an explanation of its inappropriateness. A public apology may be requested. + +2. **Warning**: Community Impact - Violation through a single incident or series of actions. + + Consequence - A warning with repercussions for continued behavior. The individual will have no interaction with the + involved parties, including unsolicited communication with those enforcing the Code of Conduct, for a specified + period. This includes abstaining from interactions in community spaces and external channels like social media. + Violation may result in a temporary or permanent ban. + +3. **Temporary Ban**: Community Impact - Serious violation of community standards, including sustained inappropriate + behavior. + + Consequence - A temporary ban from any interaction or public communication with the community for a specified period. + No public or private interaction with the involved parties is permitted, including unsolicited communication with + those enforcing the Code of Conduct. Violation may lead to a permanent ban. + +4. **Permanent Ban**: Community Impact - Demonstrating a pattern of violating community standards, including sustained + inappropriate behavior, harassment of individuals, or aggression towards or disparagement of classes of individuals. + + Consequence - A permanent ban from Bloggios community participation. + +### Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org + +[version]: http://contributor-covenant.org/version/1/4/ + +## Commit Message Format + +We uphold precise rules regarding the formatting of Git commit messages within the Bloggios project. Adhering to this format facilitates a **clearer and more comprehensible commit history**. + +Each commit message comprises a **header**, a **body** (except for "docs" commits), and an optional **footer**. + +``` + + + + + +``` + +- **Type**: Must be one of the following: + - build: Changes affecting the build system or external dependencies + - feature: Addition of new Feature + - bugFix: Fix for some bug + - ci: Changes to CI configuration files and scripts + - docs: Documentation-only changes + - perf: Code changes improving performance + - refactor: Code changes not related to bug fixes or feature additions + - test: Addition or correction of tests + +- **Summary**: A succinct description of the change: + - Use imperative, present tense (e.g., "change" not "changed" or "changes") + - Do not capitalize the first letter + - Omit periods at the end + +#### Commit Message Header + +``` +/ + │ │ + │ └─⫸ Short description about the commit. + │ + └─⫸ Commit Type: build|ci|docs|feature|bugFix|perf|refactor|test +``` + +The `` and `` fields are mandatory, the `()` field is optional. + +##### Type + +Must be one of the following: + +* **build**: Changes that affect the build system or external dependencies +* **ci**: Changes to our CI configuration files and script +* **docs**: Documentation only changes +* **feat**: A new feature +* **fix**: A bug fix +* **perf**: A code change that improves performance +* **refactor**: A code change that neither fixes a bug nor adds a feature +* **test**: Adding missing tests or correcting existing tests + +##### Summary + +Use the summary field to provide a succinct description of the change: + +* use the imperative, present tense: "change" not "changed" nor "changes" +* don't capitalize the first letter +* no dot (.) at the end + +### Revert commits + +- If the commit reverts a previous commit, begin with "revert:", followed by the header of the reverted commit. +- The body should contain: +- Information about the SHA of the reverted commit (e.g., "This reverts commit "). +- A clear description of the reason for reverting the commit. \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4717c2f --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2023 Rohit Parihar and Bloggios + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..9e96f71 --- /dev/null +++ b/README.md @@ -0,0 +1,176 @@ +
+
+ + Project Banner + +
+ +

Bloggios Mail Service

+ +
+ Java 17 + Spring Boot + Postgres + Kafka +
+
+ +## 📋 Table of Contents + +1. 🤖 [Introduction](#introduction) +2. ⚙️ [Tech Stack](#tech-stack) +3. 🔋 [Documentation](#documentation) +4. 🤸 [Quick Start](#quick-start) +5. 🕸️ [Contributing](#contributing) +6. 🔗 [Links](#links) +7. 🙏 [Support](#support) +8. ✨ [Contributors](#contributors) + +## 🤖 Introduction + +Built using Java 17 and Spring Boot, the mail is central to all notification functions using mail within a system, ensuring scalability and enhancing user experience through various features. + +## Key Features + +- **Consuming Kafka Events**: Automatically sending mail as soon as receiving any event from Kafka. +- **Sending HTML Mails**: Sending mails in more user friendly Interface with Thymeleaf. +- **Persisting Mail Records**: Persisting each and every record of mails in Postgres Database +- **OTP Management**: Handles the generation and validation of one-time passwords for 2FA or account recovery, adding an extra layer of security. + +Join our newly active Discord community for support, bug reporting, and feature requests. Here, we strive to address every issue, and developers and testers can collaborate and assist each other effectively. + + +Discord + + +## ⚙️ Tech Stack + +- Java 17 +- Spring Boot +- PostgreSQL +- Elasticsearch +- OAuth2.0 +- Kafka + +## 🔋 API Documentation + +To help you get started with our API and understand all its features and endpoints, we have created detailed documentation available on Postman. This documentation includes comprehensive information about each endpoint, including: + +- **Endpoint URLs**: Specific paths to access various functionalities. +- **HTTP Methods**: The method type (GET, POST, PUT, DELETE, etc.) for each endpoint. +- **Parameters**: Required and optional parameters, including headers, query parameters, and body content. +- **Request Examples**: Sample requests to demonstrate proper usage. +- **Response Formats**: Expected response structure, including status codes and data formats. +- **Error Handling**: Common error responses and troubleshooting tips. + +To access the documentation: + +1. **Visit our Postman Documentation Page**: [Visit Documentation](https://www.postman.com/rohit-zip/workspace/bloggios) +2. **Explore the Collection**: Navigate through the collection to find detailed descriptions and examples for each endpoint. +3. **Run Requests Directly in Postman**: Use the "Run in Postman" button to directly import the collection into your Postman workspace for testing and exploration. + +By leveraging the Postman documentation, you can quickly integrate our API into your application and take full advantage of its capabilities. + +For any further assistance, feel free to contact our support team or refer to the additional resources section in the documentation. + +## 🤸 Quick Start + +Follow these steps to set up the project locally on your machine. + +**Prerequisites** + +Make sure you have the following installed on your machine: + +- Git +- Java 17 +- Intellij Idea or any other IDE supports Spring Boot +- PostgreSql +- Kafka +- Docker (If not want to install PostgreSQL, Elasticsearch and Kafka seperately) + +**Cloning the Repository** + +```bash +git clone +``` + +**Opening the Project** + +Open the project in any of your favourite IDE +We recommended Intellij Idea + +Make sure you have Java 17 Installed in your system +Please execute the below command to check installed version of Java in your system +```bash +java --version +``` + +**Set Up Environment Variables** + +Navigate to `src/main/resources/application.yml` and add the required environment variables + +If you are new at setting environment variables the please go through the below videos +- Intellij Idea [See Video](https://www.youtube.com/watch?v=jNOh4jQJG2U) +- Eclipse or STS [See Video](https://www.youtube.com/watch?v=ypvGDkbp8Ac) + +```env +BOOTSTRAP_SERVER -> Link to kafka broker server. You can start kafka broker locally (localhost:9092) +POSTGRES_DATABASE -> Postgresql Database name +POSTGRES_HOST -> Postgres Database Host +POSTGRES_PASSWORD -> Postgres Database Password +POSTGRES_USERNAME -> Postgresq Database Username +``` + +Replace the placeholder values with your actual credentials + +**Running the Project** + +Navigate to `src/main/java/com/bloggios/auth/provider/BloggiosEmailServiceApplication.java` +Run the main method + +## 🧑‍💻Contributing + +Any kind of positive contribution is welcome! Please help us to grow by contributing to the project. + +If you wish to contribute, you can, + +- Star Repositories Bloggios +- Suggest a Feature +- Test the application, and help it improve. +- Improve the app, fix bugs, etc. +- Improve documentation. +- Create content about Bloggios and share it with the world. + +> Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us. + +🆕 New to Open Source? 💡 Follow this [guide](https://opensource.guide/how-to-contribute/) to jumpstart your Open Source journey 🚀. + +## 🔗 Links + +- **Devsanbox API's URL** - https://api.bloggios.in (Bloggios Devsandbox API) +- **Devsandbox Environment** - https://dev.bloggios.in (Bloggios Devsandbox) (*Not Deployed yet*) +- **Production Environment** - Not Deployed yet + +**Repositories** +//add here + +## 🙏Support + +We all need support and motivation. `Bloggios` is not an exception. Please give this project repositories a ⭐️ to encourage and show that you liked it. Don't forget to leave a star ⭐️ before you move away. + +If you found the app helpful, consider supporting us with a coffee. + +## ✨Contributors + +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + + + + + + + + + + +
Rohit Parihar
Rohit Parihar
💻
\ No newline at end of file diff --git a/copyright.txt b/copyright.txt new file mode 100644 index 0000000..3930767 --- /dev/null +++ b/copyright.txt @@ -0,0 +1,20 @@ +Copyright © 2023-2024 Bloggios +All rights reserved. +This software is the property of Rohit Parihar and is protected by copyright law. +The software, including its source code, documentation, and associated files, may not be used, copied, modified, distributed, or sublicensed without the express written consent of Rohit Parihar. +For licensing and usage inquiries, please contact Rohit Parihar at rohitparih@gmail.com, or you can also contact support@bloggios.com. +This software is provided as-is, and no warranties or guarantees are made regarding its fitness for any particular purpose or compatibility with any specific technology. +For license information and terms of use, please refer to the accompanying LICENSE file or visit http://www.apache.org/licenses/LICENSE-2.0. +Unauthorized use of this software may result in legal action and liability for damages. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. \ No newline at end of file