From e93d90d560e7d4e94407637a95bfddc264e342d1 Mon Sep 17 00:00:00 2001 From: simonox Date: Sat, 16 Sep 2023 12:50:24 +0200 Subject: [PATCH] Updated the README to the new folder structure. --- README.md | 42 ++++++++++++++++++++++++------------------ 1 file changed, 24 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 52b4ca9..946d6fc 100644 --- a/README.md +++ b/README.md @@ -13,35 +13,33 @@ This project is a backend solution for prototyping Internet of Things (IoT) serv ## Prerequisites +### Docker + +First install Docker and `docker-compose`: + * [Docker](https://docs.docker.com/engine/install/) * [Docker Compose](https://docs.docker.com/compose/) * [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) +If you want to use an UI for Docker, you can optionally also use [Docker Desktop](https://www.docker.com/products/docker-desktop/). + ## Installation +### Clone the Repository + ```sh -git clone https://github.com/your-repo/iot-backend-prototyping.git -cd iot-backend-prototyping +git clone https://code.curious.bio/simonox/iot-backend +cd iot-backend ``` -Launch Docker Containers - -bash +### Launch Docker Containers +```sh docker-compose up -d - - -## Docker - -First install DockerDesktop and `docker-compose`: - -- https://www.docker.com/products/docker-desktop/ -- https://docs.docker.com/compose/install/ - -```sh -docker-compose --file software/container/docker-compose.yml up ``` +## Usage + ### Mosquitto [Eclipse Mosquitto](https://mosquitto.org) is an open source message broker which implements a server for MQTT. It runs in Docker and is exposed on the default MQTT port `1883`. You can subscribe to and push into `topics`: @@ -61,7 +59,7 @@ It provides a browser-based editor that makes it easy to wire together flows usi NodeRed is also running in Docker: http://localhost:1880/ -A simple introduction to Node-RED can be found - along with the nodes / the code - in [this repository, please have a look](./software/flow/README.md)! +A simple introduction to Node-RED can be found - along with the nodes / the code - in [this repository, please have a look](./docs/flow/README.md)! ### InfluxDB @@ -75,4 +73,12 @@ InfluxDb is running here: http://localhost:8086/ (admin:adminadmin) You can login to Grafana: http://localhost:3000/login (admin:admin) -Have a look at the [HowTo in this repository](./software/dashboard/README.md). +Have a look at the [HowTo in this repository](./docs/dashboard/README.md). + +## Contribution + +Feel free to open an issue for bugs, feature requests, or questions. Contributions are welcome. + +## License + +This project follows the [REUSE Specification](https://reuse.software/spec/) and is licensed under the [GPL 3.0 or later License - see the LICENSE file](./LICENSES/GPL-3.0-or-later.txt) for details. \ No newline at end of file