offen/website
2
0
Fork 0
mirror of https://github.com/offen/website.git synced 2024-12-23 13:30:20 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #17 from offen/app-docs

Browse Source 
Add detailed README per directory
This commit is contained in:
Frederik Ring 2019-05-25 17:54:25 +02:00 committed by GitHub
commit b2c1ad1e91
2 changed files with 2 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
README.md
View File

@ -4,7 +4,7 @@
> 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.
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.
---
@ -44,77 +44,6 @@ $ 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
```
#### `script`
To work on the `script` you will need to install `docker-compose`.
First, install the project's dependencies:
```
cd script
npm install
```
Run the server:
```
docker-compose up
```
Run the tests:
```
cd script
npm test
```
### License
MIT © [offen](https://www.offen.dev)

3
docker-compose.yml
View File

@ -9,10 +9,9 @@ server:
environment:
- GOPATH=/go
- POSTGRES_CONNECTION_STRING=postgres://postgres:develop@database:5432/postgres?sslmode=disable
- VAULT_HOST=https://local.offen.dev:9977
ports:
- 8080:8080
command: go run cmd/server/main.go -conn postgres://postgres:develop@database:5432/postgres?sslmode=disable -key local.offen.dev-key.pem -cert local.offen.dev.pem
command: go run cmd/server/main.go -origin https://local.offen.dev:9977 -conn postgres://postgres:develop@database:5432/postgres?sslmode=disable -key local.offen.dev-key.pem -cert local.offen.dev.pem
links:
- database