Skip to content

Latest commit

 

History

History
38 lines (31 loc) · 2.02 KB

README.md

File metadata and controls

38 lines (31 loc) · 2.02 KB
Raw

Welcome

This project's goal is to provide first class statistics for SORMAS.

REMINDER

  • This is pre-alpha code
  • DO NOT CONNECT THIS TO A PRODUCTION SERVER

FAQ

  • Does it work (yet): Kind of
  • Should I use it in production: Absolutely not
  • Will it eat my laundry: Yes

Base directory structure

Check the READMEs in the subfolders for more details.

SORMAS-Stats
├── dev # useful tools and resources which makes a devs life easier
├── docker # necessary to run the SORMAS-Docker stack via docker-compose
├── src # directory contains useful 
│   ├── grafana # Dockerfile, dashboards and datasources for Grafana to visualize data
│   ├── old # first version of R code: Will be ported and removed eventually
│   └── stats # contains Dockerfile DB migrations, and statistics scripts in R and Python
├── .env # ENV variables for docker-compose
└── docker-compose.yml # run more or less a SORMAS-Docker stack with a stats and grafana container included

How do I build and run it?

Start the stack via docker-compose up -d. This might take a while as this starts more or less a complete SORMAS-Docker deployment including together with the statistics and grafana container of this repository.

How do I contribute?

First of all: Thank you for getting involved, we love contributions! Follow these steps:

  1. Pick or create an issue which you want to resolve
  2. Fork the project
  3. From the repo base folder run git checkout devlopment && git checkout -b feature/$issue-numer$-$some-name$. This helps the team to keep overview.
  4. Start your work: PLEASE include the issue number you are working on at the beginning of each commit message. E.g., for commits belonging to issue 123 use git commit -m '[#123] your message here' for each commit. GitHub will automatically use this to link issues and commits which makes at lot things easier.
  5. Open a Pull Request. For bigger changes, you can also consider to open a draft PR such that we can take a first look at what is going on.