Baseflow / flutter_software_architecture

The Baseflow Software Architecture for Flutter application.

The goal of this repository is to describe Baseflow's ideal architecture of Flutter applications through documentation and working examples.

Documentation

The documentation lives in the ./docs folder and consists out of Markdown files which are automatically converted into static HTML using Docsify.

To locally work with Docsify, which is useful for previewing changes locally before publishing them to GitHub, install the docsify-cli tooling using NPM:

npm install -g docsify-cli

To preview to documentation locally run the local server with docsify serve in the root of the repository:

docsify serve docs

Preview the site in a browser using the address: http://localhost:3000.

For more information on Docsify checkout their documentation page.