infinito/README.md

47 lines
2.7 KiB
Markdown
Raw Normal View History

2018-10-31 09:02:44 +01:00
# ∞infinito
2019-01-11 22:59:48 +01:00
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2448/badge)](https://bestpractices.coreinfrastructure.org/projects/2448)
2019-01-11 22:32:56 +01:00
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/2754e42b5db4404798c13d1cf871dac3)](https://app.codacy.com/app/KevinFrantz/infinito?utm_source=github.com&utm_medium=referral&utm_content=KevinFrantz/infinito&utm_campaign=Badge_Grade_Dashboard)
2019-01-19 13:06:14 +01:00
[![Build Status](https://travis-ci.org/KevinFrantz/infinito.svg?branch=master)](https://travis-ci.org/KevinFrantz/infinito) [![codecov](https://codecov.io/gh/KevinFrantz/infinito/branch/master/graph/badge.svg)](https://codecov.io/gh/KevinFrantz/infinito) [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0) [![Code of Conduct](https://img.shields.io/badge/%E2%9D%A4-code%20of%20conduct-blue.svg?style=flat)](https://github.com/KevinFrantz/infinito/blob/master/CODE_OF_CONDUCT.md) [![Release](https://img.shields.io/badge/Release-Pre--Alpha--Release-red.svg)](https://en.wikipedia.org/wiki/Software_release_life_cycle)
2018-09-05 10:48:44 +02:00
2019-01-26 16:47:51 +01:00
## Idea
2019-01-27 14:37:53 +01:00
This software should offer a cloud based application\\framework for GUI and REST based development and data management.
2019-01-26 16:47:51 +01:00
2019-01-27 14:37:53 +01:00
### Core Functions, USP & Target
2019-01-26 16:47:51 +01:00
- High differentiable of rights for persons, groups and devices
2019-01-27 14:37:53 +01:00
- Data interface for persons and devices (IoT)
2019-01-26 16:47:51 +01:00
- Support of mixtures between executables and data
- Versioning of every state of the used data
2019-01-27 14:37:53 +01:00
- Automized transparency for users about their data and use
- Expanding the standard program paradigma of classes and objects through sources
- Implementation of all big standard applications via API to manage them over one interface
- High scalability (IaaS compatible)
2018-09-05 10:48:44 +02:00
2019-01-26 16:47:51 +01:00
## Setup
2018-10-31 11:16:22 +01:00
To run the application you need docker.
2018-09-08 14:23:03 +02:00
2018-10-31 11:16:22 +01:00
After installing docker you just need to run
```bash
bash ./administration/init.sh
```
in the root directory of the repository.
2019-01-26 16:47:51 +01:00
2018-10-29 12:09:59 +01:00
## License
2019-01-26 16:47:51 +01:00
The "GNU AFFERO GENERAL PUBLIC LICENSE" applies to this project. See [LICENSE.txt](./LICENSE.txt).
2018-10-29 12:09:59 +01:00
## Code of Conduct
2019-01-26 16:47:51 +01:00
To contributions of this project the "Contributor Covenant Code of Conduct" applies. See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).
## Administration
Further information you will find in the [administration README.md](./administration/README.md).
## Application
2019-01-19 12:54:46 +01:00
Further information about the application and the architecture you will find in the [application README.md](./application/README.md).
2019-01-26 16:47:51 +01:00
## Documentation Convention
Further information you will find in the [DOCUMENTATION.md](./DOCUMENTATION_CONVENTION.md).
2019-01-26 16:47:51 +01:00
2019-01-27 14:37:53 +01:00
## Author
[Kevin Veen-Birkenbach](kevin@veen.world) \\ [Frantz](mail@Kevin-Frantz.de) <br />
[Xing](https://www.xing.com/profile/Kevin_Frantz2/) | [LinkedIn](https://www.linkedin.com/in/kevinfrantz/)