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.
46 lines
1.8 KiB
Markdown
46 lines
1.8 KiB
Markdown
# 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](https://jdav-hd.de/static/docs/index.html).
|
|
|
|
If you are interested in using the Kompass in your own local section, please get in touch via
|
|
email at `name of this project`@`merten.dev`. We are very happy to discuss how the Kompass can be used in
|
|
your setting.
|
|
|
|
# Contributing
|
|
|
|
Any form of contribution is appreciated. If you found a bug or have a feature request, please file an
|
|
[issue](https://github.com/chrisflav/kompass/issues). If you want to help with the documentation or
|
|
want to contribute code, please open a [pull request](https://github.com/chrisflav/kompass/pulls).
|
|
|
|
If you don't have a github account or don't want to open an issue or pull request here, there is
|
|
also a [Gitea repository](https://git.jdav-hd.merten.dev/digitales/kompass).
|
|
|
|
The following is a short description of where to find the documentation with more information.
|
|
|
|
# Documentation
|
|
|
|
Documentation is handled by [sphinx](https://www.sphinx-doc.org/) and located in `docs/`.
|
|
|
|
The sphinx documentation contains information about:
|
|
- Development Setup
|
|
- Architecture
|
|
- Testing
|
|
- Production Deployment
|
|
- End user documentation
|
|
- and much more...
|
|
|
|
For further details on the implementation, please head to the
|
|
[developer documentation](https://jdav-hd.de/static/docs/development_manual/index.html).
|
|
|
|
# License
|
|
|
|
This code is licensed under the [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.en.html).
|
|
For the full license text, see `LICENCSE`.
|
|
|
|
See the `NOTICE.txt` file for attributions.
|