Dzejkobik007/skolavdf
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update Readme

Browse Source
This commit is contained in:
Dzejkobik007
2023-01-19 23:41:14 +01:00
parent 1bcc8212e9
commit 383d1a5c34
1 changed files with 16 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
wap/mac-check/README.md
View File

@@ -6,6 +6,8 @@ API na zjištovaní zda je mac addressa přiřazená k vyrobci, po případě k
Aplikace běží na Node.JS Aplikace běží na Node.JS
Demo Url: [mac-check.starraria.eu](https://mac-check.starraria.eu)
## API ## API
### GET /api ### GET /api
@@ -19,4 +21,17 @@ Vratí mac adresu s výrobcem pokud byl nalezen, jinak vratí chybu.
**Query Parameters** **Query Parameters**
|| Required | Default Value | Desc | || Required | Default Value | Desc |
|--|--|--|--| |--|--|--|--|
| `format` | `no` | `json` | Specifikuje jaký formát má být použit při odpovědi. Možnosti jsou: `json`,`xml`,`csv` | | `format` | `no` | `json` | Specifikuje jaký formát má být použit při odpovědi. Možnosti jsou: `json`,`xml`,`csv` |
## Quick start (On linux)
```bash
git clone https://github.com/Dzejkobik007/skolavdf.git
mv skolavdf/wap/mac-check ./
rm -rf skolavdf
cd mac-check/
docker-compose up -d --build
```
## Requirements
- docker
- docker-compose