docs: update Readme and Developer guides (#1543)

* docs: update Readme and Developer guides * docs: update Readme wording
2026-07-16 16:47:05 +02:00 · 2026-04-28 05:41:48 +02:00
parent 2e031de790
commit 5355193084
13 changed files with 77 additions and 49 deletions
@@ -3,65 +3,49 @@
 [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/f-eld-ch/sitrep/badge)](https://scorecard.dev/viewer/?uri=github.com/f-eld-ch/sitrep)


-![Lage](docs/images/Lage1.png?raw=true "Lage")
-![Lage2](docs/images/Lage2.png?raw=true "Lage2")
-![Overview](docs/images/IncidentOverview.png?raw=true "Overview")
-![Editor](docs/images/MessageEditor.png?raw=true "Message Editor")
-![Feed](docs/images/JournalFeed.png?raw=true "Feed")
+## Turn Crisis Into Clarity
+
+Sitrep is a real-time situation management software for command staffs. Track, coordinate, and communicate during emergencies with a unified digital platform built for high-pressure decision-making. SitRep is build to not stand in your way by having to keep yet another system updated. It aims to simplify and digitize tedious manual processes and stream line message flow within a command center. It's build for civil protection services and not aiming towards military use. 
+
+### Journal and Audit Logging
+
+The central piece of SitRep is it's Journal. All incoming and outgoing messages and communications are logged into SitReps journal. Writing messages digital is proven to be faster and less error prone nowadays than writing messagesheets by hand. After the message logging a centralized triage person is triagin all messages to the approporate command staff recipiens - also this can be achieved fully digitalized - or messagesheets can be easily printed and multiplied. 
+
+![Jornal](docs/images/Journal.png?raw=true "Journal-Editor")
 ![Triage](docs/images/Triage.png?raw=true "Triage")

+### Digital Crisis Map
+
+SitRep offers basic functionality to draw crisis maps aimed to inform command staff about the current situation. This is only an initial version and we aim to fully include this in the improve message routing flow through SitRep. It supports a basic subset of symbols available from the [Federal Office for Civil Protection FOCP](https://www.babs.admin.ch/en).
+
+![Lage](docs/images/Map_Drawing.png?raw=true "Lage")
+![Lagekarte](docs/images/Map_tilted.png?raw=true "Lagekarte")
+![Satelliten](docs/images/Map_Sat.png?raw=true "Sateliten Karte")
+![Gefahrenkarten](docs/images/Map_Gefahrenkarte.png?raw=true "Gefahren-Karte")
+
+## Feedback & Feature Requests
+
+All feedback and feature requests are welcome. Please check the [discussions](https://github.com/f-eld-ch/sitrep/discussions) and [open issues](https://github.com/f-eld-ch/sitrep/issues) first.
+
+
 ## Demo-Environment

 The current develop version is automatically deployed to: [https://demo.sitrep.ch](https://demo.sitrep.ch)
-Login is possible with your Github account or sign-up for a new account at Auth0.
+The data is automatically cleaned periodically - don't use this environment to run your crisis!

-## SitRep As A Service
+Login is possible with your Github account or sign-up for a new account.

-[F-ELD](https://www.sitrep.ch) is offering SitRep as a managed service for organizations which are members of the F-ELD association.
+## Backed by F-ELD
+
+SitRep is open-source software developed and stewarded by [F-ELD](https://f-eld.ch) - is a Swiss Non-Profit association. Their main purpose is to develop, improve SitRep and educate command staffs around Switzerland how to best leverage digital tools for Civil Protection purposes. 
+
+### SitRep As A Service
+
+[F-ELD](https://f-eld.ch) is offering SitRep as a managed service for organizations which are members of the F-ELD association.
 The managed services are hosted on a secure infrastructure in Switzerland and are operated by the F-ELD team.
 The hosting partner is [VSHN](https://www.vshn.ch). For further information, please reach out to [info@f-eld.ch](mailto:info@f-eld.ch).

-### Local Development Environment
-
-A simple local development environment can be created using docker compose and the frontend can be run using yarn.
-
-1. Install docker / docker compose and yarn / node 16+
-
-2. 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%
-```
-
-3. Run docker compose environment:
-
-```
-docker compose --env-file .env.local up -d
-```
-
-If you are running on a SElinux enabled machine, use the selinux compose file:
-
-```
-docker compose -f docker-compose.selinux.yml --env-file .env.local up -d
-```
-
-4. Run yarn
-
-```
-cd ui && yarn start
-```
-
-5. Open [localhost:3000](http://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**.
-
-### Translations
+## Translations

 To correct or add **translations** we invite you to help us out [on Transifex](https://explore.transifex.com/f-eld/sitrep/).
 We currently support the following languages:
@@ -0,0 +1,44 @@
+## Getting Started
+
+### Local Development Environment
+
+A simple local development environment can be created using docker compose and the frontend can be run using yarn.
+
+1. Install docker / docker compose and yarn / node 16+
+
+2. 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%
+```
+
+3. Run docker compose environment:
+
+```
+docker compose --env-file .env.local up -d
+```
+
+If you are running on a SElinux enabled machine, use the selinux compose file:
+
+```
+docker compose -f docker-compose.selinux.yml --env-file .env.local up -d
+```
+
+4. Run yarn
+
+```
+cd ui && yarn start
+```
+
+5. Open [localhost:3000](http://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**.
+
+
+6. Start go backend server