├── .github ├── config.yml ├── ISSUE_TEMPLATE │ ├── question.md │ ├── feature_request.md │ └── bug_report.md ├── workflows │ ├── release.yml │ └── cla.yml ├── stale.yml ├── README-template.md └── pull_request_template.md ├── charts └── akita-helm-chart │ ├── templates │ ├── akita-secrets.yml │ └── akita-daemonset.yaml │ ├── values.yaml │ ├── .helmignore │ └── Chart.yaml ├── .gitignore ├── README.md ├── CLA.md ├── CONTRIBUTING.md └── LICENSE /.github/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: Community Forum 4 | url: https://community.tyk.io 5 | About: Ask a question in TYK Community Forum. 6 | 7 | -------------------------------------------------------------------------------- /charts/akita-helm-chart/templates/akita-secrets.yml: -------------------------------------------------------------------------------- 1 | apiVersion: v1 2 | kind: Secret 3 | metadata: 4 | name: akita-secrets 5 | type: Opaque 6 | data: 7 | api-key-id: {{required "A base64 .Values.apiKeyId from the Akita console is required" .Values.apiKeyId}} 8 | api-key-secret: {{required "A base64 .Values.apiKeySecret from the Akita console is required" .Values.apiKeySecret}} 9 | 10 | -------------------------------------------------------------------------------- /charts/akita-helm-chart/values.yaml: -------------------------------------------------------------------------------- 1 | #the Akita project you can get it from Akita Console 2 | project: "" 3 | ## The Akita docker image tag 4 | tag: 0.21.15 5 | ##kubenerertes image pull policy 6 | pullPolicy: Always 7 | #must be base64 you can get it from akita console 8 | apiKeyId: "" 9 | #must be base64 you can get it from akita console 10 | apiKeySecret: "" 11 | #port you want to listen to ## 12 | port: 9007 -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/question.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "❓Ask A question" 3 | about: Ask a question 4 | title: ASK IN THE COMMUNITY FORUM ! 5 | labels: question 6 | assignees: '' 7 | 8 | --- 9 | 10 | Issues in this repo are for feature request and bug reporting. 11 |
12 | For questions please find us in the community forum: https://community.tyk.io 13 |
14 |
15 | Clients can also use support@tyk.io. 16 |
17 | Potential clients and evaluators, please use info@tyk.io. 18 | -------------------------------------------------------------------------------- /charts/akita-helm-chart/.helmignore: -------------------------------------------------------------------------------- 1 | # Patterns to ignore when building packages. 2 | # This supports shell glob matching, relative path matching, and 3 | # negation (prefixed with !). Only one pattern per line. 4 | .DS_Store 5 | # Common VCS dirs 6 | .git/ 7 | .gitignore 8 | .bzr/ 9 | .bzrignore 10 | .hg/ 11 | .hgignore 12 | .svn/ 13 | # Common backup files 14 | *.swp 15 | *.bak 16 | *.tmp 17 | *.orig 18 | *~ 19 | # Various IDEs 20 | .project 21 | .idea/ 22 | *.tmproj 23 | .vscode/ 24 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release Charts 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | 8 | jobs: 9 | release: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - name: Checkout 13 | uses: actions/checkout@v2 14 | with: 15 | fetch-depth: 0 16 | 17 | - name: Configure Git 18 | run: | 19 | git config user.name "$GITHUB_ACTOR" 20 | git config user.email "$GITHUB_ACTOR@users.noreply.github.com" 21 | 22 | - name: Run chart-releaser 23 | uses: helm/chart-releaser-action@v1.1.0 24 | env: 25 | CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}" -------------------------------------------------------------------------------- /.github/stale.yml: -------------------------------------------------------------------------------- 1 | # Number of days of inactivity before an issue becomes stale 2 | daysUntilStale: 60 3 | # Number of days of inactivity before a stale issue is closed 4 | daysUntilClose: 11 5 | # Issues with these labels will never be considered stale 6 | exemptLabels: 7 | - pinned 8 | - security 9 | 10 | # Label to use when marking an issue as stale 11 | staleLabel: wontfix 12 | # Comment to post when marking an issue as stale. Set to `false` to disable 13 | markComment: > 14 | This issue has been automatically marked as stale because it has not had 15 | recent activity. It will be closed if no further activity occurs. Thank you 16 | for your contributions. 17 | # Comment to post when closing a stale issue. Set to `false` to disable 18 | closeComment: false -------------------------------------------------------------------------------- /charts/akita-helm-chart/Chart.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: v2 2 | name: akita-helm-chart 3 | description: A Helm chart for Kubernetes 4 | 5 | # A chart can be either an 'application' or a 'library' chart. 6 | # 7 | # Application charts are a collection of templates that can be packaged into versioned archives 8 | # to be deployed. 9 | # 10 | # Library charts provide useful utilities or functions for the chart developer. They're included as 11 | # a dependency of application charts to inject those utilities and functions into the rendering 12 | # pipeline. Library charts do not define any templates and therefore cannot be deployed. 13 | type: application 14 | 15 | # This is the chart version. This version number should be incremented each time you make changes 16 | # to the chart and its templates, including the app version. 17 | # Versions are expected to follow Semantic Versioning (https://semver.org/) 18 | version: 0.0.4 19 | 20 | # This is the version number of the application being deployed. This version number should be 21 | # incremented each time you make changes to the application. Versions are not expected to 22 | # follow Semantic Versioning. They should reflect the version the application is using. 23 | # It is recommended to use it with quotes. 24 | appVersion: "0.0.4" 25 | -------------------------------------------------------------------------------- /charts/akita-helm-chart/templates/akita-daemonset.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: apps/v1 2 | kind: DaemonSet 3 | metadata: 4 | name: akita-capture-{{ .Release.Name }} 5 | spec: 6 | selector: 7 | matchLabels: 8 | name: akita-capture-{{ .Release.Name }} 9 | template: 10 | metadata: 11 | labels: 12 | name: akita-capture-{{ .Release.Name }} 13 | spec: 14 | containers: 15 | - image: "akitasoftware/cli:{{.Values.tag}}" 16 | imagePullPolicy: {{ .Values.pullPolicy }} 17 | name: akita-{{ .Chart.Name }} 18 | args: 19 | - apidump 20 | - --service 21 | - {{required "A project name from the Akita console is required" .Values.project}} 22 | - --rate-limit 23 | - "200" 24 | - --filter 25 | - port {{.Values.port}} 26 | env: 27 | - name: AKITA_API_KEY_ID 28 | valueFrom: 29 | secretKeyRef: 30 | name: akita-secrets 31 | key: api-key-id 32 | - name: AKITA_API_KEY_SECRET 33 | valueFrom: 34 | secretKeyRef: 35 | name: akita-secrets 36 | key: api-key-secret 37 | dnsPolicy: ClusterFirst 38 | hostNetwork: true 39 | restartPolicy: Always 40 | 41 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: enhancement 6 | assignees: '' 7 | 8 | --- 9 | 17 | ### Is your feature request related to a problem? Please describe. 18 | 19 | 20 | 21 | 34 | 35 | ### Current Behavior 36 | 37 | 38 | 39 | ### Describe the solution you'd like 40 | 41 | 42 | ### Describe alternatives you've considered 43 | 44 | 45 | ### Additional context 46 | 47 | -------------------------------------------------------------------------------- /.github/README-template.md: -------------------------------------------------------------------------------- 1 | # 2 | 13 | 14 | ## About 15 | This repo is doing ... 16 | 17 | ## Purpose 18 | You can use it for .... 19 | 20 | ## Getting started 21 | To get started do ... 22 | 23 | 24 | ## PRs 25 | Explain the requirements for a PR... 26 | 27 | #### SLA 28 | First response (clarifying questions/guidance on improvements/answering questions) - target of 48 hours 29 | Detailed review and feedback on PRs - target 7 days 30 | 31 | 32 | 33 | ## Bugs 34 | 35 | #### SLA 36 | First response (clarifying questions/guidance on improvements/answering questions) - target of 48 hours 37 | 38 | 39 | 40 | ## Features 41 | 42 | #### SLA 43 | First response (clarifying questions/guidance on improvements/answering questions) - target 72 hours 44 | 45 | ### Questions 46 | For question on products, please use [Tyk Community forum](https://community.tyk.io/). 47 |
48 | Clients can also use support@tyk.io. 49 |
50 | Potential clients and evaluators, please use info@tyk.io. 51 | 52 | 53 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | ### JetBrains template 3 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider 4 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 5 | 6 | # User-specific stuff 7 | local-value.yaml 8 | .idea/**/workspace.xml 9 | .idea/**/tasks.xml 10 | .idea/**/usage.statistics.xml 11 | .idea/**/dictionaries 12 | .idea/**/shelf 13 | .idea/ 14 | .idea 15 | # Generated files 16 | .idea/**/contentModel.xml 17 | 18 | # Sensitive or high-churn files 19 | .idea/**/dataSources/ 20 | .idea/**/dataSources.ids 21 | .idea/**/dataSources.local.xml 22 | .idea/**/sqlDataSources.xml 23 | .idea/**/dynamic.xml 24 | .idea/**/uiDesigner.xml 25 | .idea/**/dbnavigator.xml 26 | 27 | # Gradle 28 | .idea/**/gradle.xml 29 | .idea/**/libraries 30 | 31 | # Gradle and Maven with auto-import 32 | # When using Gradle or Maven with auto-import, you should exclude module files, 33 | # since they will be recreated, and may cause churn. Uncomment if using 34 | # auto-import. 35 | # .idea/artifacts 36 | # .idea/compiler.xml 37 | # .idea/jarRepositories.xml 38 | # .idea/modules.xml 39 | # .idea/*.iml 40 | # .idea/modules 41 | # *.iml 42 | # *.ipr 43 | 44 | # CMake 45 | cmake-build-*/ 46 | 47 | # Mongo Explorer plugin 48 | .idea/**/mongoSettings.xml 49 | 50 | # File-based project format 51 | *.iws 52 | 53 | # IntelliJ 54 | out/ 55 | 56 | # mpeltonen/sbt-idea plugin 57 | .idea_modules/ 58 | 59 | # JIRA plugin 60 | atlassian-ide-plugin.xml 61 | 62 | # Cursive Clojure plugin 63 | .idea/replstate.xml 64 | 65 | # Crashlytics plugin (for Android Studio and IntelliJ) 66 | com_crashlytics_export_strings.xml 67 | crashlytics.properties 68 | crashlytics-build.properties 69 | fabric.properties 70 | 71 | # Editor-based Rest Client 72 | .idea/httpRequests 73 | 74 | # Android studio 3.1+ serialized cache file 75 | .idea/caches/build_file_checksums.ser 76 | 77 | 78 | -------------------------------------------------------------------------------- /.github/workflows/cla.yml: -------------------------------------------------------------------------------- 1 | name: "CLA Assistant" 2 | on: 3 | issue_comment: 4 | types: [created] 5 | pull_request_target: 6 | types: [opened,closed,synchronize] 7 | 8 | jobs: 9 | CLAssistant: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - name: "CLA Assistant" 13 | if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target' 14 | # Beta Release 15 | uses: contributor-assistant/github-action@v2.2.0 16 | env: 17 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 18 | PERSONAL_ACCESS_TOKEN : ${{ secrets.ORG_GH_TOKEN}} 19 | with: 20 | path-to-signatures: 'signatures/version1/cla.json' 21 | path-to-document: 'https://github.com/TykTechnologies/tyk/blob/master/CLA.md' 22 | # branch should not be protected 23 | branch: 'main' 24 | ##people who don't have to sign the CLA comma separated e.g user1,user2 25 | allowlist: bot* 26 | #below are the optional inputs - If the optional inputs are not given, then default values will be taken 27 | remote-organization-name: 'TykTechnologies' 28 | remote-repository-name: cla 29 | #create-file-commit-message: 'For example: Creating file for storing CLA Signatures' 30 | #signed-commit-message: 'For example: $contributorName has signed the CLA in #$pullRequestNo' 31 | #custom-notsigned-prcomment: 'pull request comment with Introductory message to ask new contributors to sign' 32 | #custom-pr-sign-comment: 'The signature to be committed in order to sign the CLA' 33 | #custom-allsigned-prcomment: 'pull request comment when all contributors has signed, defaults to **CLA Assistant Lite bot** All Contributors have signed the CLA.' 34 | lock-pullrequest-aftermerge: true 35 | 36 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # What is Akita 2 | 3 | [Akita](https://www.akitasoftware.com/) is a tool that generate Open Api Specification (OAS) by observing your traffic. 4 | 5 | ### Akita Helm Chart 6 | 7 | This repo is an Akita helm chart that you can install in your kubernetes cluster and akita will start producing OAS for your. 8 | 9 | ### How To use this helm chart 10 | 11 | [Helm](https://helm.sh) Must be installed to use this chart.Please refer to 12 | Helm's [documentation](https://helm.sh/docs) to get started. 13 | 14 | Once Helm has been set up correctly, add the repo as follows: 15 | 16 | `helm repo add https://tyktechnologies.github.io/akita-helm-chart` 17 | 18 | For example if you choose `akita-online` as your alias you would write something like: 19 | `helm repo add akita-online https://tyktechnologies.github.io/akita-helm-chart` 20 | 21 | If you had already added this repo earlier, run `helm repo update` to retrieve 22 | the latest versions of the packages. You can then run `helm search repo 23 | ` to see the charts. 24 | 25 | #### How To Install the chart into your cluster. 26 | For this chart to work the following values are required: 27 | 1. **project** - This is the akita project you want to send the data into.You can create the project name from the [akita console](https://app.akita.software/). 28 | 2. **apiKeyId** - It has to be base64 encoded.You can get it from the [akita console](https://app.akita.software/). 29 | 3. **apiKeySecret**- It has to be base64 encoded.You can get it from the [akita console](https://app.akita.software/). 30 | 31 | **Optional Values** 32 | 1. **port**-This is the port whose traffic you want to monitor.For example if your app listens on port 9007 you will pass 9007 as the port. 33 | 34 | To install the akita-helm-chart chart into your cluster run: 35 | `helm install /akita-helm-chart --set apiKeyId= --set apiKeySecret= --set project=` 36 | 37 | After the installation akita will start creating the OAS for you!! 38 | 39 | #### To uninstall the chart from your cluster: 40 | `helm delete ` 41 | 42 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | ## Description 2 | 3 | 4 | ## Related Issue 5 | 6 | 7 | 8 | 9 | 10 | ## Motivation and Context 11 | 12 | 13 | ## Test Coverage For This Change 14 | 15 | 17 | 18 | ## Screenshots (if appropriate) 19 | 20 | ## Types of changes 21 | 22 | - [ ] Bug fix (non-breaking change which fixes an issue) 23 | - [ ] New feature (non-breaking change which adds functionality) 24 | - [ ] Breaking change (fix or feature that would cause existing functionality to change) 25 | - [ ] Refactoring or add test (improvements in base code or adds test coverage to functionality) 26 | 27 | 28 | ## Checklist 29 | 30 | 31 | - [ ] Make sure you are requesting to **pull a topic/feature/bugfix branch** (right side). If PRing from your fork, don't come from your `master`! 32 | - [ ] Make sure you are making a pull request against our **`master` branch** (left side). Also, it would be best if you started *your change* off *our latest `master`*. 33 | - [ ] My change requires a change to the documentation. 34 | - [ ] I have manually updated the README(s)/documentation accordingly. 35 | - [ ] If you've changed APIs, describe what needs to be updated in the documentation. 36 | - [ ] If new config option added, ensure that it can be set via ENV variable 37 | - [ ] I have updated the documentation accordingly. 38 | - [ ] Modules and vendor dependencies have been updated; run `go mod tidy && go mod vendor` 39 | - [ ] When updating library version must provide reason/explanation for this update. 40 | - [ ] I have added tests to cover my changes. 41 | - [ ] All new and existing tests passed. 42 | - [ ] Check your code additions will not fail linting checks: 43 | - [ ] `go fmt -s` 44 | - [ ] `go vet` -------------------------------------------------------------------------------- /CLA.md: -------------------------------------------------------------------------------- 1 | ## Contributor License Agreement 2 | The following terms are used throughout this agreement: 3 | 4 | * You - the person or legal entity including its affiliates asked to accept this agreement. An affiliate is any entity that controls or is controlled by the legal entity, or is under common control with it. 5 | * Project - is an umbrella term that refers to any and all Tyk Technologies open source projects. 6 | * Contribution - any type of work that is submitted to a Project, including any modifications or additions to existing work. 7 | * Submitted - conveyed to a Project via a pull request, commit, issue, or any form of electronic, written, or verbal communication with Tyk Technologies, contributors or maintainers. 8 | 9 | ### 1. Grant of Copyright License. 10 | 11 | Subject to the terms and conditions of this agreement, You grant to the Projects’ maintainers, contributors, users and to Tyk Technologies 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 Your contributions and such derivative works. Except for this license, You reserve all rights, title, and interest in your contributions. 12 | 13 | ### 2. Grant of Patent License. 14 | 15 | Subject to the terms and conditions of this agreement, You grant to the Projects’ maintainers, contributors, users and to Tyk Technologies 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 your contributions, where such license applies only to those patent claims licensable by you that are necessarily infringed by your contribution or by combination of your contribution with the project to which this contribution was submitted. 16 | 17 | If any entity institutes patent litigation - including cross-claim or counterclaim in a lawsuit - against You alleging that your contribution or any project it was submitted to constitute or is responsible for direct or contributory patent infringement, then any patent licenses granted to that entity under this agreement shall terminate as of the date such litigation is filed. 18 | 19 | ### 3. Source of Contribution. 20 | 21 | Your contribution is either your original creation, based upon previous work that, to the best of your knowledge, is covered under an appropriate open source license, and you have the right under that license to submit that work with modifications, whether created in whole or in part by you, or you have clearly identified the source of the contribution and any license or other restriction (like related patents, trademarks, and license agreements) of which you are personally aware. -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: 🐛 Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: bug 6 | assignees: 7 | 8 | --- 9 | 10 | 14 | 15 | ## Describe the bug 16 | 22 | 23 | ## Expected Behaviour 24 | 25 | 26 | ## Current Behaviour 27 | 28 | 29 | ## Possible Solution 30 | 31 | 32 | ## Steps To Reproduce 33 | 34 | 39 | 44 | ## Important configurations 45 | 46 | 47 | ## Logs/Errors 48 | 53 | 54 | ## Screenshots/Video 55 | 56 | 57 | ## Context 58 | 59 | 60 | 61 | ## Your Environment 62 | 63 | 64 | 68 | ## Additional context 69 | 70 | 71 | 72 | 73 | 74 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Table of Contents 2 | 1. [Contributing to Tyk](#contributing-to-tyk) 3 | 2. [Our SLA for issues and bugs](#our-sla-for-issues-and-bugs) 4 | 3. [Filling an issue](#filling-an-issue) 5 | 4. [Contributor License Agreements](#contributor-license-agreements) 6 | 5. [Guidelines for Pull Requests](#guidelines-for-pull-requests) 7 | 6. [Project Structure](#project-structure) 8 | 7. [Building and Running test](#building-and-running-test) 9 | 8. [Coding Conventions](#coding-conventions) 10 | 9. [Resources](#resources) 11 | 12 | # Contributing to Tyk 13 | 14 | **First**: if you're unsure or afraid of anything, just ask or submit the issue or pull request anyway. You won't be yelled at for giving your best effort. The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contributions, and don't want a wall of rules to get in the way of that. 15 | 16 | However, for those individuals who want a bit more guidance on the best way to contribute to the project, read on. This document will cover what we're looking for. By addressing all the points we're looking for, it raises the chances we can quickly merge or address your contributions. 17 | 18 | ### Our SLA for issues and bugs 19 | We do value the time each contributor spends contributing to this repo, and we work hard to make sure we respond to your issues and Pull request as soon as we can. 20 | 21 | Below we have outlined. 22 | 23 | ### Filling an issue 24 | Before opening an issue, if you have a question about Tyk or have a problem using it, please 25 | start with the GitHub search and our [community forum](https://community.tyk.io). 26 | If that doesn't answer your questions, and you have an idea for a new capability or if you think you found a bug, [file an 27 | issue](/issues/new). 28 | 29 | ### Contributor License Agreements 30 | 31 | Before we can accept any PR the contributor need to sign the [TYK CLA](./CLA.md). 32 | 33 | Once you are CLA'ed, we'll be able to accept your pull requests.For any issues that you face during this process, please create a GitHub issue explaining the problem, and we will help get it sorted out. 34 | 35 | ### Guidelines for Pull Requests 36 | We have created a few guidelines to help with creating PR. To make sure these requirements are followed we added them to the PR form as well: 37 | 38 | 1. When working on an existing issue, simply respond to the issue and express interest in working on it. This helps other people know that the issue is active, and hopefully prevents duplicated efforts. 39 | 2. For new ideas or breaking changes it is always better to open an issue and discuss your idea with our team first, before implementing it. 40 | 3. Create small Pull request that address a single issue instead of multiple issues at the same time. This will make it possible for the PRS to be reviewed independently. 41 | 5. Make sure to run tests locally before submitting a pull request and verify that all of them are passing. 42 | 6. Documentation - a new capability or improvement needs to be exposed in the form of documentation which needs to be created before this PR is merged. Please open a ticket in [Tyk docs repo](https://github.com/TykTechnologies/tyk-docs/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=) with all the relevant content and link it to the code PR. We are also happy work with you on creating docs so please let us know. Once the docs are ready and review has been done we can merge the PR 43 | 7. Tips for making sure we review your pull request faster : 44 | 1. Code is documented. Please comment the code where possible, especially for fields and functions. 45 | 2. Use meaningful commit messages. 46 | 3. Keep your pull request up to date with upstream master to avoid merge conflicts. 47 | 4. Provide a good PR description as a record of what change is being made and why it was made. Link to a GitHub issue if it exists. 48 | 5. Tick all the relevant checkboxes in the PR form 49 | 50 | ### Project Structure 51 | [sample project structure](https://github.com/getkin/kin-openapi/tree/0846d700650012c02a16668ebd2bf1e77e9a1669#structure) 52 | 1. *folder one(package one) - explain what is in this package and what code in this package does ...* 53 | 2. *folder one(package one) - explain what is in this package and what code in this package does ...* 54 | 3. *folder one(package one) - explain what is in this package and what code in this package does ...* 55 | 56 | ### Building and Running test 57 | *explain to the contributor how there can build and run test cases for this project* 58 | 59 | ### Coding Conventions 60 | *if your team has any coding conventions write them here* 61 | 62 | ### Resources 63 | - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) 64 | - [Using Pull Requests](https://help.github.com/articles/about-pull-requests/) 65 | 66 | 67 | 68 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | --------------------------------------------------------------------------------