README.md 2.1 KB
Newer Older
1
# IQRF Gateway Webapp
Roman Ondráček's avatar
Roman Ondráček committed
2

Roman Ondráček's avatar
Roman Ondráček committed
3
[![Build Status](https://gitlab.iqrf.org/open-source/iqrf-gateway-webapp/badges/master/build.svg)](https://gitlab.iqrf.org/open-source/iqrf-gateway-webapp/pipelines)
Roman Ondráček's avatar
Roman Ondráček committed
4
[![Apache License](https://img.shields.io/badge/license-APACHE2-blue.svg)](LICENSE)
5
6
[![API documentation](https://img.shields.io/badge/docs-api-brightgreen.svg)](https://apidocs.iqrf.org/iqrf-gateway-webapp/)
[![User documentation](https://img.shields.io/badge/docs-user-blue.svg)](https://docs.iqrf.org/iqrf-gateway-webapp/)
Roman Ondráček's avatar
Roman Ondráček committed
7

8
This is web application for managing IQRF Gateway Daemon's configuration.
Roman Ondráček's avatar
Roman Ondráček committed
9
10
11

## Installation

12
See the installation guide [here](https://docs.iqrf.org/iqrf-gateway/webapp-install.html).
13

14
15
## Requirements

Roman Ondráček's avatar
Roman Ondráček committed
16
PHP 7.4 or higher. To check whether server configuration meets the minimum requirements for [Nette Framework](https://doc.nette.org/3.0/requirements).
17

18
### Web server
19

Roman Ondráček's avatar
Roman Ondráček committed
20
21
22
23
24
For Apache or Nginx, setup a virtual host to point to the `www/` directory of the project and you should be ready to go.

It is *CRITICAL* that whole `app/`, `log/` and `temp/` directories are not accessible directly via a web browser. See [security warning](https://nette.org/security-warning).

## License
25

26
This project is licensed under Apache License 2.0:
Roman Ondráček's avatar
Roman Ondráček committed
27

Karel Hanák's avatar
Karel Hanák committed
28
 > Copyright 2017-2021 IQRF Tech s.r.o.
29
 >
Karel Hanák's avatar
Karel Hanák committed
30
 > Copyright 2019-2021 MICRORISC s.r.o.
31
 >
Roman Ondráček's avatar
Roman Ondráček committed
32
 > Licensed under the Apache License, Version 2.0 (the "License");
33
 >
Roman Ondráček's avatar
Roman Ondráček committed
34
 > you may not use this file except in compliance with the License.
35
 >
Roman Ondráček's avatar
Roman Ondráček committed
36
 > You may obtain a copy of the License at
37
 >
Roman Ondráček's avatar
Roman Ondráček committed
38
 >     http://www.apache.org/licenses/LICENSE-2.0
39
 >
Roman Ondráček's avatar
Roman Ondráček committed
40
 > Unless required by applicable law or agreed to in writing, software
41
 >
Roman Ondráček's avatar
Roman Ondráček committed
42
 > distributed under the License is distributed on an "AS IS" BASIS,
43
 >
Roman Ondráček's avatar
Roman Ondráček committed
44
 > WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
45
 >
Roman Ondráček's avatar
Roman Ondráček committed
46
 > See the License for the specific language governing permissions and
47
 >
Roman Ondráček's avatar
Roman Ondráček committed
48
 > limitations under the License.
Rostislav Spinar's avatar
Rostislav Spinar committed
49
50
51
52

 ## Acknowledgement

This project has been made possible with a government grant by means of [the Ministry of Industry and Trade of the Czech Republic](https://www.mpo.cz/) in [the TRIO program](https://starfos.tacr.cz/cs/project/FV40132).