Merge pull request #1 from Foxentry/feat/release-1-0-0

feat: release 1.0.0

Author: Pryx

.github/issue_template.md

@@ -0,0 +1,47 @@
+# ! To prevent creating a duplicate, please check for previous issues before making a new one. !
+
+## Issue Description
+
+[To help us better understand the issue you are experiencing, please be as detailed as possible. Try to be as detailed as you can.]
+
+## Steps to Reproduce
+
+[Describe the steps you took to get into the issue. Bring back every step of the process, down to the last detail, including all of the inputs, outputs you anticipated, and results you achieved. This enables us to identify and solve the problem more quickly.]
+
+1. Step 1
+2. Step 2
+3. ...
+
+## Expected Behavior
+
+[Give a detailed description of the desired behavior you aimed to achieve with the flow.]
+
+## Actual Behavior
+
+[Give a detailed description of the actual behavior.]
+
+## Screenshots
+
+[Provide us with screenshots of the faulty behavior if possible. With this, we can get a clearer picture of the issue.]
+
+## Environment
+
+[Please describe the environment in which the issue occurred.]
+
+- **Operating System:**
+- **Browser (if applicable):**
+- **Version/Commit ID (if applicable):**
+
+## Additional Information
+
+[Please share any further details you may have that could lead to a solution to this problem.]
+
+## Labels
+
+[Mention any labels that you think are relevant to this issue, such as "bug," "enhancement," etc.]
+
+## Assignees
+
+[If there's a specific person or team responsible for addressing this issue, assign them here. If not, you can leave this section blank.]
+
+---

.github/pull_request_template.md

@@ -0,0 +1,38 @@
+# !Make sure that your branch is based on the latest changes in the main/master branch before submitting the pull request.!
+
+## Pull Request Description
+
+[Please give us as much information as possible about the pull request you want us to approve. Please be as detailed as possible.]
+
+## Related Issue
+
+[Please add related issue.]
+
+## Changes Made
+
+[List the specific changes made in this pull request.]
+
+- Change 1
+- Change 2
+- ...
+
+## Screenshots
+
+[If applicable, include screenshots that showcase the changes.]
+
+# Checklist
+
+- [ ] I have tested these changes locally.
+- [ ] I have updated the documentation.
+- [ ] My code follows our project's coding style.
+- [ ] I have added/modified relevant tests.
+- [ ] All existing tests are passing.
+- [ ] I have rebased my branch on the latest main/master.
+
+## Additional Information
+
+[Please share any further details you may have.]
+
+## Assignees
+
+[If there's a specific person or team responsible for reviewing and merging this pull request, assign them here. If not, you can leave this section blank.]

.github/workflows/maven-publish.yml

@@ -0,0 +1,26 @@
+name: Publish package to the Maven Central Repository
+on:
+  release:
+    types: [created]
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Maven Central Repository
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          server-id: ossrh
+          server-username: MAVEN_USERNAME
+          server-password: MAVEN_PASSWORD
+          gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }}
+          gpg-passphrase: MAVEN_GPG_PASSPHRASE
+      - name: Publish package
+        run: |
+          mvn clean deploy -P release -DskipTests=true --batch-mode
+        env:
+          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
+          MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
+          MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}

.github/workflows/test.yml

@@ -0,0 +1,17 @@
+name: Test SDK
+on:
+  - push
+
+jobs:
+  build_and_test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 17
+        uses: actions/setup-java@v1
+        with:
+          java-version: 17
+
+      - name: Build project with Maven
+        run: mvn -B package --file pom.xml

.gitignore

@@ -0,0 +1,50 @@
+tmp
+
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# Maven
+target/
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+replay_pid*
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### OSX ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride

CODE_OF_CONDUCT.md

@@ -0,0 +1,43 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project email 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 by contacting the project team at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated promptly and fairly.
+
+All project team members are obligated to respect the privacy and security of the reporter of any incident.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).

CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Contributing to com.foxentry.foxentrysdk
+
+Thank you for considering contributing to com.foxentry.foxentrysdk! We appreciate your efforts in helping to improve our project. Please take a moment to review this document for guidelines on how to contribute.
+
+## Ways to Contribute
+
+There are several ways you can contribute to this project:
+
+- Reporting issues
+- Suggesting enhancements
+- Submitting pull requests for bug fixes or new features
+
+## How to Contribute
+
+### Reporting Issues
+
+If you encounter any issues or bugs, please use the GitHub issue tracker to report them. When reporting issues, please provide as much detail as possible, including:
+
+- A clear and descriptive title
+- A detailed description of the issue
+- Steps to reproduce the issue, if applicable
+- Any relevant error messages or screenshots
+
+### Suggesting Enhancements
+
+If you have suggestions for enhancements or new features, please feel free to open an issue on GitHub. Please provide a clear and detailed description of your suggestion, including why you think it would be beneficial for the project.
+
+### Submitting Pull Requests
+
+We welcome pull requests for bug fixes, improvements, and new features. Before submitting a pull request, please ensure the following:
+
+- Fork the repository and create a new branch for your changes.
+- Make your changes, and provide clear and descriptive commit messages.
+- Test your changes thoroughly.
+- Ensure that your code follows the existing coding style and guidelines.
+- Update any relevant documentation or examples to reflect your changes.
+
+## Contact
+
+If you have any further questions or need assistance, please feel free to reach out to us at [[email protected]](mailto:[email protected]).
+
+Thank you again for your interest in contributing to com.foxentry.foxentrysdk

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Foxentry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.