https://github.com/akvo/akvo-lumen
Make sense of your data
https://github.com/akvo/akvo-lumen
agplv3 akvo akvo-lumen clojure d3 data-cleaning data-visualization react
Last synced: about 1 month ago
JSON representation
Make sense of your data
- Host: GitHub
- URL: https://github.com/akvo/akvo-lumen
- Owner: akvo
- License: agpl-3.0
- Created: 2015-10-19T11:25:53.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T11:32:23.000Z (over 2 years ago)
- Last Synced: 2023-03-10T21:48:01.731Z (over 2 years ago)
- Topics: agplv3, akvo, akvo-lumen, clojure, d3, data-cleaning, data-visualization, react
- Language: JavaScript
- Homepage: https://akvo.org/akvo-lumen
- Size: 33.8 MB
- Stars: 62
- Watchers: 15
- Forks: 18
- Open Issues: 9
-
Metadata Files:
- Readme: README.dev.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Development setup
Akvo Lumen provides a Docker Compose file to start the whole system in development mode.
This Docker Compose environment will have:
- Two tenants
- A KeyCloak server with some accounts setup
- A PostgreSQL DB
- A Backend server with a REPL
- A Client with hot reloading
- A Windshaft server
- A Redis DB
## Hosts
Akvo Lumen is a multi tenant system and to do enable local routing to the tenants
the following hosts must be defined in your /etc/hosts file:
``` sh
127.0.0.1 t1.lumen.local
127.0.0.1 t2.lumen.local
127.0.0.1 auth.lumen.local
```
Or just
sudo sh -c 'echo "127.0.0.1 t1.lumen.local t2.lumen.local auth.lumen.local" >> /etc/hosts'
## Start development environment
Before starting the following ports that must be free: 8080, 3000, 3030, 47480, 5432
To start:
```sh
docker-compose up --build -d && docker-compose logs -f --tail=10
```
To stop:
```sh
docker-compose down -v
```
## User
To add your email and use Google as authenticator run the local-admin script.
```
./backend/dev_helpers/local-admin.sh
```
## Keycloak
Keycloack is available at http://auth.lumen.local:8080/
The admin password for keycloak is "admin" / "password". There is an "akvo" realm, where two tenants (t1 & t2) and they are represesnted by the following groups:
```
akvo
└── lumen
├── t1
│ └── admin
└── t2
└── admin
```
Available users are:
- "lumen" service account
- "jerome" t1 admin
- "salim" t1 user
- "ruth" t2 admin
- "harry" t2 user
- "kaj" keycloak user not on a tenant
All passwords are "password".
## Client
The Akvo Lumen UI should be accessible at:
- http://t1.lumen.local:3030/
- http://t2.lumen.local:3030/
The Docker Compose file mounts the "client" directory, so any changes in the source directory should
be picked up automatically by the Webpack server.
#### Tests
Run:
```sh
docker-compose exec client npm test
```
## Backend
The tenants api root should be accessible at
- http://t1.lumen.local:3000/api
- http://t2.lumen.local:3000/api
Hitting that endpoint should print the tenants dns label and connection pool.
A Clojure REPL should be available on port 47480.
## Puppeteer
To run the test of the puppeteer user simulator, just go to lumen main
folder and run:
```sh
./ci/e2e-test.sh
```
#### Tests
To run the tests, either do it from the REPL or run:
```sh
docker-compose exec backend lein test
```
#### Postgres
To connect to the postgres server connect using something like:
```sh
docker-compose exec backend psql --host=akvo-lumen_postgres_1 --port=5432 --dbname=lumen_tenant_1 --username=lumen --password
```
To enable postgres SQL statement logging execute:
```sh
./backend/dev_helpers/enable-pg-logging.sh
```
## Windshaft
This container has a development version of the Windshaft container, with plenty of hardcoded assumptions.
The Windshaft server is not exposed directly to the external world, but it is proxied by the Webpack server
on the url http://t1.lumen.local:3030/maps/**. That url forwards the requests to "windshaft:4000".
## Legal
Copyright © 2016 - present Akvo Foundation
### Thanks
[BrowserStack](http://www.browserstack.com) is supporting Akvo, allowing us to use their service and infrastructure to test the code in this repository. Thank you for supporting the open source community!