Flood API

Setup

To get started, clone the repository.

git clone https://github.com/JamieBriggsDev/FloodApi.git
git submodule init
git submodule update

To run Swagger UI locally using the Flood API OpenAPI spec, use docker-compose:

docker-compose up -d --build

API Setup

Before building the package, a file needs creating for the WIFI settings. Copy the existing example header file:

cp api/include/wifi_settings.h.example api/include/wifi_settings.h

This file then needs populating with your WiFi SSID and password. Refrain from pushing this file up.

Tools (WIP)

For this solution, I wanted to see how easy it was to create a REST API in C++. Several tools exist, but for the purposes of this I chose aWot.

Need to insert other considerations here.

To install Pistache, you can follow this guide, but otherwise you can clone the repo and use meson to build and install it. If you do not have meson, you can install via brew.

git clone https://github.com/pistacheio/pistache.git
cd pistache
meson setup build
meson install -C build

To install PlatformIO, which is used to flash an ESP32 microcontroller, use homebrew:

brew install paltformio

There is also the PlatformIO plugin for CLion. Guidance can be found here.

For ESP32 related tools, install esp32:

brew install espressif

Drivers for ESP32 and serial found here.