offen/website
2
0
Fork 0
mirror of https://github.com/offen/website.git synced 2024-11-25 10:10:28 +01:00
Code Issues Projects Releases Wiki Activity
Mirror of github.com/offen/website
41 Commits 2 Branches 0 Tags 32 MiB
HTML 63.2%
CSS 20%
Python 10.9%
Makefile 4.4%
JavaScript 0.8%
Other 0.7%
b2c1ad1e91
Go to file
Frederik Ring b2c1ad1e91 Merge pull request #17 from offen/app-docs 
Add detailed README per directory
2019-05-25 17:54:25 +02:00
.circleci add tests for script app 2019-05-23 17:13:44 +02:00
.editorconfig install shared packages via npm 2019-05-23 10:52:32 +02:00
.gitignore enable using ssl in local development 2019-04-25 20:08:17 -06:00
CODE_OF_CONDUCT.md refer to real world .dev domain 2019-05-01 20:34:00 -06:00
docker-compose.yml add detailed README per directory 2019-05-25 17:41:37 +02:00
LICENSE Initial commit 2019-04-10 16:58:26 +02:00
README.md add detailed README per directory 2019-05-25 17:41:37 +02:00

README.md

offen

CircleCI Pivotal Tracker

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. See each of the READMEs in the subdirectories for instructions on how to work on that particular area of the application.

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
  1. Install and setup mkcert. Assuming you have Go installed, this looks like:
$ go get -u github.com/FiloSottile/mkcert
$ mkcert -install
  1. 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.

License

MIT © offen