website/README.md

offen

The offen analytics software

This repository contains all source code needed to build and run offen, both on the server as well as on the client.

---

Development of offen has just started, so instructions are rare and things will stay highly volatile for quite some while. Also do not use the software in its current state as it is still missing crucial pieces in protecting the data end to end.

Guidelines for running and developing the Software will be added when it makes sense to do so.

Project planning and issue tracking is done using Pivotal Tracker, but feel free to open a GitHub issue if you have a question or found a bug.

Developing the application

Local cookies and SSL

In local development offen requires to be served both via SSL (in order to use window.crypto) as well as a local.offen.dev host.

This requires the following steps to be taken:

1. Edit your /etc/hosts to include the following line:

127.0.0.1       local.offen.dev

2. Install and setup mkcert. Assuming you have Go installed, this looks like:

$ go get -u github.com/FiloSottile/mkcert
$ mkcert -install

3. Navigate into the repository root and create a local certificate and key for the local.offen.dev host:

$ mkcert local.offen.dev

You can test setup by starting the application:

$ docker-compose up

Now you should be able to access https://local.offen.dev:8080/status in your browser without any security warnings.

server

To work on the server you will need to install docker-compose and Go 1.12+.

First, bootstrap the dockerized Postgres database used for development:

docker-compose run server make bootstrap

Run the server:

docker-compose up

Run the tests:

docker-compose run server make

vault

To work on the vault you will need to install docker-compose.

First, install the project's dependencies:

cd vault
npm install

Run the server:

docker-compose up

Run the tests:

cd vault
npm test

License

MIT © offen