Skip to content
David Wyss edited this page Jun 3, 2022 · 14 revisions

PolygonSoftware Flox Wiki

This wiki serves as a baseline of information for developing projects with Flox.

In a first part, it outlines the basic principles and structures of Flox. In its second part, more development-specific information is given, and the code quality guidelines are established.

What is Flox?

Flox is a bootstrap repository intended to provide a solid baseline for starting new projects. It provides a full-stack, basic setup of all relevant services. It includes Terraform files for setting up the related AWS infrastructure, as well as a basic Backend, Frontend, Database, and preconfigured connections between them. Some basic examples for operations and components are included as well.

There are two workflows for Flox projects: the standard workflow, and the minimal workflow. You can find out more about these on their respective Wiki pages.

How is Flox structured?

Flox follows a two-part approach:

  • Basics: things that will most likely be needed for all projects
  • Flox Modules: Optional modules with self-contained functionality (e.g. file upload, role management, etc.) that can be dynamically enabled/disabled and configured.

Flox Modules