website/README.md

# offen
[![CircleCI](https://circleci.com/gh/offen/offen/tree/master.svg?style=svg)](https://circleci.com/gh/offen/offen/tree/master)
[![Pivotal Tracker](https://img.shields.io/static/v1.svg?label=Project+Planning&message=Pivotal+Tracker&color=informational)](https://www.pivotaltracker.com/n/projects/2334535)
[![Patreon](https://img.shields.io/static/v1.svg?label=patreon&message=donate&color=e85b46)](https://www.patreon.com/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. 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](https://www.pivotaltracker.com/n/projects/2334535), but feel free to open a GitHub issue if you have a question or found a bug.

### Developing the application

The development setup requires `docker` and `docker-compose` to be installed.

After cloning the repository, you can build the containers and install dependencies using:

```sh
$ make setup
```

Next, create a local encryption key for the `kms` service and seed the database for the `server` application:

```sh
$ make bootstrap
```

You can test your setup by starting the application:

```sh
$ docker-compose up
```

which should enable you to access <http://localhost:9955/> and use the `auditorium`

### Developing the homepage

In order to ease sharing of styles, the <https://www.offen.dev> site is also part of this repository. It runs in a separate development environment:

```
$ cd homepage
$ make setup
$ docker-compose up
```

A live reloading development server will run on <http://localhost:8000>.

### License

MIT © [offen](https://www.offen.dev)
Initial commit 2019-04-10 16:58:26 +02:00			`# offen`
add continuous integration badge to README 2019-04-20 03:41:21 +02:00			`[![CircleCI](https://circleci.com/gh/offen/offen/tree/master.svg?style=svg)](https://circleci.com/gh/offen/offen/tree/master)`
add link to pivotal tracker board 2019-04-26 04:19:47 +02:00			`[![Pivotal Tracker](https://img.shields.io/static/v1.svg?label=Project+Planning&message=Pivotal+Tracker&color=informational)](https://www.pivotaltracker.com/n/projects/2334535)`
add patreon account 2019-06-23 16:52:34 +02:00			`[![Patreon](https://img.shields.io/static/v1.svg?label=patreon&message=donate&color=e85b46)](https://www.patreon.com/offen)`
add link to pivotal tracker board 2019-04-26 04:19:47 +02:00
scaffold project setup and http server 2019-04-10 18:17:24 +02:00			`> The offen analytics software`

add detailed README per directory 2019-05-25 17:34:09 +02:00			`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.`
scaffold project setup and http server 2019-04-10 18:17:24 +02:00
			`---`

add link to pivotal tracker board 2019-04-26 04:19:47 +02:00			`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.`
scaffold project setup and http server 2019-04-10 18:17:24 +02:00
add link to pivotal tracker board 2019-04-26 04:19:47 +02:00			`Project planning and issue tracking is done using [Pivotal Tracker](https://www.pivotaltracker.com/n/projects/2334535), but feel free to open a GitHub issue if you have a question or found a bug.`
scaffold project setup and http server 2019-04-10 18:17:24 +02:00
clean up router package 2019-04-19 18:56:24 +02:00			`### Developing the application`

set up simpler dockerized dev env for node apps 2019-06-20 12:57:36 +02:00			The development setup requires `docker` and `docker-compose` to be installed.
enable using ssl in local development 2019-04-26 04:08:17 +02:00
set up simpler dockerized dev env for node apps 2019-06-20 12:57:36 +02:00			`After cloning the repository, you can build the containers and install dependencies using:`

			```sh
			`$ make setup`
			```

			Next, create a local encryption key for the `kms` service and seed the database for the `server` application:

			```sh
			`$ make bootstrap`
enable using ssl in local development 2019-04-26 04:08:17 +02:00			```
set up simpler dockerized dev env for node apps 2019-06-20 12:57:36 +02:00
			`You can test your setup by starting the application:`

			```sh
enable using ssl in local development 2019-04-26 04:08:17 +02:00			`$ docker-compose up`
			```

use shared style across homepage and auditorium 2019-07-26 10:48:38 +02:00			which should enable you to access <http://localhost:9955/> and use the `auditorium`

			`### Developing the homepage`

			`In order to ease sharing of styles, the <https://www.offen.dev> site is also part of this repository. It runs in a separate development environment:`

			```
			`$ cd homepage`
			`$ make setup`
			`$ docker-compose up`
			```

			`A live reloading development server will run on <http://localhost:8000>.`
enable using ssl in local development 2019-04-26 04:08:17 +02:00
scaffold project setup and http server 2019-04-10 18:17:24 +02:00			`### License`

refer to real world .dev domain 2019-05-02 04:34:00 +02:00			`MIT © [offen](https://www.offen.dev)`