jogueber / sormas-project Goto Github PK

SORMAS (Surveillance Outbreak Response Management and Analysis System) is an open source eHealth system - consisting of separate web and mobile apps - that is geared towards optimizing the processes used in monitoring the spread of infectious diseases and responding to outbreak situations.

You can give SORMAS a try on our play server at https://sormas.helmholtz-hzi.de!

Read through our Contributing Readme and contact us at [email protected] or join our developer chat on Gitter to learn how you can help to drive the development of SORMAS forward and to get development support from our core developers. SORMAS is a community-driven project, and we'd love to have you on board! If you want to contribute to the code, please strictly adhere to the Development Environment guide to ensure that everything is set up correctly. Please also make sure that you've read the Development Contributing Guidelines before you start to develop.

Please create a new issue and read the Submitting an Issue guide for more detailed instructions. We appreciate your help!

SORMAS officially supports and is tested on Chromium-based browsers (like Google Chrome) and Mozilla Firefox, and all Android versions starting from Android 7.0 (Nougat). In principle, SORMAS should be usable with all web browsers that are supported by Vaadin 8 (Chrome, Firefox, Safari, Edge, Internet Explorer 11; see https://vaadin.com/faq).

Yes! Please download the latest release and copy the content of /deploy/openapi/sormas-rest.yaml to an editor that generates a visual API documentation (e.g. https://editor.swagger.io/).
Runtime Swagger documentation of the External Visits Resource (used by external symptom journals such as CLIMEDO or PIA) is also available at <<host>>/sormas-rest/visits-external/openapi.json or <<host>>/sormas-rest/visits-external/openapi.yaml

The project consists of the following modules:

• sormas-api: General business logic and definitions for data exchange between app and server
• sormas-app: The Android app
• sormas-backend: Server entity services, facades, etc.
• sormas-base: Base project that also contains build scripts
• sormas-ear: The ear needed to build the application
• sormas-rest: The REST interface; see sormas-rest/README.md
• sormas-ui: The web application
• sormas-base/dependencies: dependencies to be deployed with the payara server
• sormas-cargoserver: setup for a local dev server using maven-cargo

• Installing a SORMAS server
• Updating a SORMAS server
• Customizing a SORMAS server