The current develop version is automatically deployed to: https://demo.sitrep.ch Login is possible with your Github account or sign-up for a new account at Auth0.
A simple local development environment can be created using docker compose and the frontend can be run using yarn.
-
Install docker / docker compose and yarn / node 16+
-
Create a .env.local file setting these variables:
Oauth2_PROXY clients can be created using Auth0....
OAUTH2_PROXY_CLIENT_ID=sitrep
OAUTH2_PROXY_CLIENT_SECRET=ds8LCRW4jhB58nWdMgZHeVISqx3O3e1o3g0LEr9H8tM= # generate with: openssl rand -base64 32 | tr -- '+/' '-_'
OAUTH2_PROXY_COOKIE_SECRET=kvicWov5Y_w10r2vmnxJTUTugMUtBp6_R4loxuANMtg= # generate with: openssl rand -base64 32 | tr -- '+/' '-_'
HASURA_GRAPHQL_ADMIN_SECRET=388HMfQ00gEyg636O63S1jxRODTSoAiu_XHa0fXhtRo= # generate with: openssl rand -base64 32 | tr -- '+/' '-_'
POSTGRES_PASSWORD=postgrespassword
OAUTH2_PROXY_REDIRECT_URL=http://localhost:3000/oauth2/callback # port for yarn dev server%
- Run docker compose environment:
docker compose --env-file .env.local up -d
- Run yarn
cd ui && yarn start
- Open localhost:3000. This will automatically proxy to the OAUTH2 proxy which will then proxy requests towards the graphql-engine with its /v1/graphql. Authentication will be handled by the local dex IDP with it's mock provider. Just click on Log in with Example.
To correct or add translations we invite you to help us out on Transifex. We currently support the following languages:
- German (de)
- English (en)
- Italian (it)
- French (fr)