KOMPASS - digitales Verwaltungssystem für die JDAV https://jdav-hd.merten.dev/kompass
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Christian Merten 6ffa2376b8
settings: use toml configuration files
We replace the current environment variable based configuration approach by
reading all local configuration from a `settings.toml` configuration file.
The docker test, development and production setups have been updated to use
the new setup.

The configuration folder also allows overriding every template in a
`config/templates` directory. We use this in a follow-up to move
all local specific templates, e.g. the registration form, into this
config directory.
11 months ago
docker settings: use toml configuration files 11 months ago
docs Update and enhance documentation (#100) 11 months ago
jdav_web settings: use toml configuration files 11 months ago
.dockerignore docker: add test setup 3 years ago
.gitignore settings: use toml configuration files 11 months ago
.gitmodules fix path of jet 4 years ago
Jenkinsfile ci: collect coverage report 3 years ago
Makefile docker/test: improve setup 11 months ago
README.md Update and enhance documentation (#100) 11 months ago
requirements.txt Update and enhance documentation (#100) 11 months ago

README.md

jdav Kompass

Build Status

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