-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
739c465
commit 0b6e955
Showing
8 changed files
with
127 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
<p align='center'> | ||
<img src='https://raw.githubusercontent.com/FerramONG/ferramong-tools-manager/master/docs/img/logo/logo.png?raw=true' /> | ||
</p> | ||
|
||
<h1 align='center'>FerramONG - Tools Manager</h1> | ||
<p align='center'>Service responsible for the authentication and registration of users, in addition, it also generates and validates session tokens.</p> | ||
<p align="center"> | ||
<a href="https://github.com/FerramONG/ferramong-tools-manager/actions/workflows/windows.yml"><img src="https://github.com/FerramONG/ferramong-tools-manager/actions/workflows/windows.yml/badge.svg" alt=""></a> | ||
<a href="https://github.com/FerramONG/ferramong-tools-manager/actions/workflows/macos.yml"><img src="https://github.com/FerramONG/ferramong-tools-manager/actions/workflows/macos.yml/badge.svg" alt=""></a> | ||
<a href="https://github.com/FerramONG/ferramong-tools-manager/actions/workflows/ubuntu.yml"><img src="https://github.com/FerramONG/ferramong-tools-manager/actions/workflows/ubuntu.yml/badge.svg" alt=""></a> | ||
<a href="http://java.oracle.com"><img src="https://img.shields.io/badge/java-12+-D0008F.svg" alt="Java compatibility"></a> | ||
<a href="https://github.com/FerramONG/ferramong-tools-manager/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-BSD0-919191.svg" alt="License"></a> | ||
<a href="https://github.com/FerramONG/ferramong-tools-manager/releases"><img src="https://img.shields.io/github/v/release/FerramONG/ferramong-tools-manager" alt="Release"></a> | ||
</p> | ||
<hr /> | ||
|
||
## ❇ 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 | |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.