diff --git a/.github/workflows/macos.yml b/.github/workflows/macos.yml new file mode 100644 index 0000000..13b5c20 --- /dev/null +++ b/.github/workflows/macos.yml @@ -0,0 +1,24 @@ +name: macos + +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +jobs: + build: + + runs-on: macos-latest + + steps: + - uses: actions/checkout@v2 + - name: Set up JDK 11 + uses: actions/setup-java@v2 + with: + java-version: '11' + distribution: 'adopt' + - name: Grant execute permission for gradlew + run: chmod +x gradlew + - name: Build with Gradle + run: ./gradlew build diff --git a/.github/workflows/ubuntu.yml b/.github/workflows/ubuntu.yml new file mode 100644 index 0000000..8679dc7 --- /dev/null +++ b/.github/workflows/ubuntu.yml @@ -0,0 +1,24 @@ +name: ubuntu + +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - name: Set up JDK 11 + uses: actions/setup-java@v2 + with: + java-version: '11' + distribution: 'adopt' + - name: Grant execute permission for gradlew + run: chmod +x gradlew + - name: Build with Gradle + run: ./gradlew build diff --git a/.github/workflows/windows.yml b/.github/workflows/windows.yml new file mode 100644 index 0000000..2d3609b --- /dev/null +++ b/.github/workflows/windows.yml @@ -0,0 +1,24 @@ +name: windows + +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +jobs: + build: + + runs-on: windows-latest + + steps: + - uses: actions/checkout@v2 + - name: Set up JDK 11 + uses: actions/setup-java@v2 + with: + java-version: '11' + distribution: 'adopt' + - name: Grant execute permission for gradlew + run: chmod +x gradlew + - name: Build with Gradle + run: ./gradlew build diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..957c7f0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,12 @@ +Copyright (c) 2021 Carlos M F P Santiago, Gabriel Arruda dos Santos, Matheus Hiroyuki Suwa Moura, Renan Kummer de Jesus, William Niemiec + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH +REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY +AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, +INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM +LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR +OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +PERFORMANCE OF THIS SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..852c823 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +

+ +

+ +

FerramONG - Tools Manager

+

Service responsible for the authentication and registration of users, in addition, it also generates and validates session tokens.

+

+ + + + Java compatibility + License + Release +

+
+ +## ❇ Introduction +This source code is a webservice that is used to manage and manipulate the amount of credit that each user has, in addiction to adding or removing the user's credits. + +## ❓ How to use +See [here](https://ferramong-tools-manager.herokuapp.com/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config) OpenAPI doc. + +## ⚠ Warnings +The hosting service Heroku may have a certain delay (~ 1 min) for uploading the application so the loading of the website may have a certain delay. + +## 🚩 Changelog +Details about each version are documented in the [releases section](https://github.com/FerramONG/ferramong-tools-manager/releases). + +## 🗺 Project structure +#### FerramONG architecture +![global-schema](https://raw.githubusercontent.com/FerramONG/ferramong-tools-manager/master/docs/img/schemas/architecture.png?raw=true) + +#### Tools Manager class diagram +![class-diagram](https://raw.githubusercontent.com/FerramONG/ferramong-tools-manager/master/docs/img/diagrams/class-diagram.png?raw=true) + +## 📁 Files +### / +| Name |Type|Description| +|----------------|-------------------------------|-----------------------------| +|dist |`Directory`|Released versions| +|docs |`Directory`|Documentation files| +|src |`Directory`| Source files | +|test |`Directory`| Test files | diff --git a/docs/img/diagrams/class-diagram.png b/docs/img/diagrams/class-diagram.png new file mode 100644 index 0000000..b9715aa Binary files /dev/null and b/docs/img/diagrams/class-diagram.png differ diff --git a/docs/img/logo/logo.png b/docs/img/logo/logo.png new file mode 100644 index 0000000..3c434a1 Binary files /dev/null and b/docs/img/logo/logo.png differ diff --git a/docs/img/schemas/architecture.png b/docs/img/schemas/architecture.png new file mode 100644 index 0000000..d33e938 Binary files /dev/null and b/docs/img/schemas/architecture.png differ