curious.bio/iot-backend
5
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Updated the README to the new folder structure.

Browse source
This commit is contained in:
simonox 2023-09-16 12:50:24 +02:00
parent 3c75579102
commit e93d90d560
1 changed files with 24 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -13,35 +13,33 @@ This project is a backend solution for prototyping Internet of Things (IoT) serv
## Prerequisites ## Prerequisites
### Docker
First install Docker and `docker-compose`:
* [Docker](https://docs.docker.com/engine/install/) * [Docker](https://docs.docker.com/engine/install/)
* [Docker Compose](https://docs.docker.com/compose/) * [Docker Compose](https://docs.docker.com/compose/)
* [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) * [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 ## Installation
### Clone the Repository
```sh ```sh
git clone https://github.com/your-repo/iot-backend-prototyping.git git clone https://code.curious.bio/simonox/iot-backend
cd iot-backend-prototyping cd iot-backend
``` ```
Launch Docker Containers ### Launch Docker Containers
bash
```sh
docker-compose up -d 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 ### 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`: [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/ 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 ### 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) 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.