Flumen

Product Sheet
Technical Documentation

Product Sheet

Name	FLOW + Lumen = Flumen
Product Description	Akvo Flow is a tool for collecting, evaluating and displaying of geographically referenced data. It is composed of an android mobile app and an online web-based platform. This repository contains code for the web-based platform that comprises a backend engine and a dashboard user interface. Alongside the dashboard and mobile apps, is a data import and export component Akvo Lumen is an easy to use data mashup, analysis and publishing platform.
Repository Link	https://github.com/akvo/akvo-flow https://github.com/akvo/akvo-flow-mobile https://github.com/akvo/akvo-lumen
Product Documentation	https://kb.akvo.org/flow/ https://kb.akvo.org/lumen/
Tech Stack	Akvo Flow: Frontend: Ember.js, React, Clojurescript, Android App Backend: Java Database: Google Cloud Datastore Services: Amazon S3, Auth0 CI: Semaphoreci Hosting: Google App Engine Akvo Lumen Frontend: React Backend: Clojure Database: PostgreSQL Services: Auth0 CI: Semaphoreci Hosting: Google Kubernetes Engine
Asana Link	FLOW Backlog: https://app.asana.com/0/1204599091585163 FLOW Sprintboard: https://app.asana.com/0/1204279546124153
Slack Channel Link	#team-flow: https://app.slack.com/client/T044V5F9W/C04NFHZBJ69 #team-lumen: https://app.slack.com/client/T044V5F9W/C04NJG3B68J

Technical Documentation

Flumen - Technical support scripts

Tech support scripts all exist in the flow repo https://github.com/akvo/akvo-flow/tree/master/scripts/data

Flumen - Instance set up

Once a new contract is in, we need to set up the partner with Flumen. The process is simple: send the Project management file to Greta (for Finance tracking), Isha (for SaaS tracking) and Jana (to set up the instance). Jana will take care of the instance set up with the Flumen team and let you know once it is ready.

Make sure the Project management file has all the details needed for the instance set up:

Project/Organisation name
Project manager
Hubs involved
Akvo admin
Contract end date
Flumen URL (desired URL)
Pricing tier

You can find the Project management template here.

Flumen - Technical Setup

What is an instance?

Notes: Flow instance is essentially a GCP project. For each partner a unique project is created.

Creating an instance

Environment setup

Install Google cloud SDK - https://cloud.google.com/sdk/docs/install-sdk

Which repos are involved in deploying new instance?

https://github.com/akvo/akvo-flow-server-config - configuration for both repos above. I.e backend/UI + mobile
https://github.com/akvo/akvo-config/ - DNS/subdomain configuration for Flow instances
https://github.com/akvo/akvo-flow - main Akvo flow application (backend and dashboard)
https://github.com/akvo/akvo-flow-mobile - mobile app (each instance has own configured mobile app deployed)

Which other repos may need to be checked?

https://github.com/akvo/akvo-flow-services - report generation backend.
https://github.com/akvo/akvo-webform - flow webforms (coordinate with Deden for configuration re/loading)

Cheatsheets