ramen: Raft Consensus on Mesh Network

See the wiki page for further details.

ramen API

Full documentation can be found here.

Development Setup Instructions

• Make sure to initialize the submodules
  • git submodule update --init --recursive
• Install Docker, Clang, ClangFormat, Clang-Tidy
  • sudo apt install docker.io clang clang-format clang-tidy
• Install PlatformIO, Black, Pylint
  • pip install platformio black pylint
• Open the repository in Visual Studio Code
• Install the recommended extensions for the project, a box will popup on lower left corner
  • See this page
• That's it!

Licencing

This project is published under GNU GPLv3 License and the ramen logo was adapted from icons made by Freepik from www.flaticon.com