# Flumen

# Product Sheet

<table border="1" id="bkmrk-name-name-of-the-pro" style="border-collapse: collapse; width: 100%; height: 394.375px;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Name**  
</td><td style="height: 29.7969px;">FLOW + Lumen = Flumen</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;">**Product Description**  
</td><td style="height: 46.5938px;">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.

</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Repository Link**  
</td><td style="height: 29.7969px;">[https://github.com/akvo/akvo-flow](https://github.com/akvo/akvo-flow)

[https://github.com/akvo/akvo-flow-mobile](https://github.com/akvo/akvo-flow-mobile)

[https://github.com/akvo/akvo-lumen](https://github.com/akvo/akvo-lumen)

</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Product Documentation**</td><td style="height: 29.7969px;">[https://kb.akvo.org/flow/](https://kb.akvo.org/flow/)

[https://kb.akvo.org/lumen/](https://kb.akvo.org/lumen/)

</td></tr><tr style="height: 182px;"><td style="height: 182px;">**Tech Stack**</td><td style="height: 182px;">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

</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;">**Asana Link**  
</td><td style="height: 46.5938px;">FLOW Backlog: [https://app.asana.com/0/1204599091585163](https://app.asana.com/0/1204599091585163)

FLOW Sprintboard: [https://app.asana.com/0/1204279546124153](https://app.asana.com/0/1204279546124153)

</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Slack Channel Link**</td><td style="height: 29.7969px;">\#team-flow: [https://app.slack.com/client/T044V5F9W/C04NFHZBJ69](https://app.slack.com/client/T044V5F9W/C04NFHZBJ69)

 #team-lumen: [https://app.slack.com/client/T044V5F9W/C04NJG3B68J](https://app.slack.com/client/T044V5F9W/C04NJG3B68J)

</td></tr></tbody></table>

# 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](https://github.com/akvo/akvo-flow/tree/master/scripts/data)

## Flumen - Instance set up

[![image.png](https://wiki.cloud.akvo.org/uploads/images/gallery/2023-06/scaled-1680-/MqpN0XpWT4kwutc3-image.png)](https://drive.google.com/file/d/1pg1jTllDv9AtmxewHdCYIZR61ZicSmC8/view?usp=drive_link)

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

<span style="font-size: 11pt; font-family: Assistant,sans-serif; color: #000000; background-color: transparent; font-weight: 400; font-style: normal; font-variant: normal; text-decoration: none; vertical-align: baseline; white-space: pre-wrap;"><span style="border: none; display: inline-block; overflow: hidden; width: 602px; height: 349px;">![](https://lh4.googleusercontent.com/z1cxsq3DjLCZWPOqCbqXFZo7bh6dwPKYpC1viz6EgJe1n5m_Hpq52tCssR4xWEg9ZQSml02bGVLCvJtTfO8ZZkku0ou7zxf2I3y6RgbsZms4Z2Bjh25M0im0BNA4nIs1FZAflgR1c-7pw10SSZ_5Jw)</span></span>

**<span style="font-size: 11pt; font-family: Assistant,sans-serif; color: #000000; background-color: transparent; font-weight: 400; font-style: normal; font-variant: normal; text-decoration: none; vertical-align: baseline; white-space: pre-wrap;">You can find the Project management template [here](https://docs.google.com/spreadsheets/d/1m12r_cuuNICUGaLJcfAY11tH9wOdqxxoPp2Y5ZK5-mc/edit).</span>**

## 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](https://cloud.google.com/sdk/docs/install-sdk)

#### Which repos are involved in deploying new instance?

- [https://github.com/akvo/akvo-flow-server-config](https://github.com/akvo/akvo-flow-server-config) - configuration for both repos above. I.e backend/UI + mobile
- [https://github.com/akvo/akvo-config/](https://github.com/akvo/akvo-config/) - DNS/subdomain configuration for Flow instances
- [https://github.com/akvo/akvo-flow](https://github.com/akvo/akvo-flow) - main Akvo flow application (backend and dashboard)
- [https://github.com/akvo/akvo-flow-mobile](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](https://github.com/akvo/akvo-flow-services) - report generation backend.
- [https://github.com/akvo/akvo-webform](https://github.com/akvo/akvo-webform) - flow webforms (coordinate with Deden for configuration re/loading)

#### Cheatsheets

##### Backend/Dashboard Instance creation 

- [https://github.com/akvo/akvo-flow-server-config/blob/master/creating-new-dashboard-instances.md](https://github.com/akvo/akvo-flow-server-config/blob/master/creating-new-dashboard-instances.md)

##### Mobile app

- [https://github.com/akvo/akvo-flow-mobile/wiki/Deployments](https://github.com/akvo/akvo-flow-mobile/wiki/Deployments)
    - Check under the section -

##### Lumen deployments

- [https://github.com/akvo/akvo-lumen/blob/master/NEW\_TENANT.md](https://github.com/akvo/akvo-lumen/blob/master/NEW_TENANT.md)