jdav Kompass

Kompass is an administration platform designed for local sections of the Young German Alpine Club. It provides tools to contact and (automatically) manage members, groups, material, excursions and statements.

For more details on the features, see the (German) documentation.

Contributing

Any form of contribution is appreciated. If you found a bug or have a feature request, please file an issue. If you want to help with the documentation or want to contribute code, please open a pull request.

The following is a short description of where to find the documentation with more information.

Documentation

Documentation is handled by sphinx and located in docs/.

The sphinx documentation contains information about:

• Development Setup
• Architecture
• Testing
• Production Deployment
• End user documentation
• and much more...

Please add all further documentation also in the sphinx documentation. And not in the readme

online

Online (latest release version): https://jdav-hd.de/static/docs/

local

To read the documentation build it locally and view it in your browser:

cd docs/
make html

# MacOS (with firefox)
open -a firefox $(pwd)/docs/build/html/index.html 
# Linux (I guess?!?)
firefox ${pwd}/docs/build/html/index.html