Floro Mono

Project Structure Overview

This repository is the mono-repository of the following applications

• Projects

  • The Floro Desktop App
  • The Floro Chrome Extension
  • The Floro Backend Service
  • The Floro Web Front-End

• Plugin Projects (docs coming soon, follow src/App.tsx files)

  • Text
  • Icons
  • Theme
  • Palette

Floro CLI & VCS

For code related to the floro CLI & version control client please go to this repository.

For Self-Host Deploing

For code related to the deploying to a cloud provider please go to this repository.

Documentation References

Please read the product docs here before getting started.

Please read the OSS guide here.

Setting up the development environment

Floro development has NOT been tested on windows (aside from development on the desktop client).

Prerequisites

• You will need
  • Node 19.9.0
  • Postgres 13+
  • Redis 7.2.3+
  • Yarn

For plugins development, please make sure you have the latest version of the floro-cli installed.

npm install floro -g

Download the deps from the root of the mono-repo

yarn install

Download and build the floro assets

yarn build:floro_assets

Running the project

After starting up postgres and the redis server, to start the web server, you can run

yarn build

yarn main:dev

App will run on http://localhost:9000