digitales
/
kompass
4
1
Fork 1
Code Issues 45 Pull Requests 2 Packages Projects Releases Wiki Activity
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.
571 Commits
22 Branches
0 Tags
15 MiB
Python 61.4%
CSS 15%
HTML 11.5%
SCSS 7.6%
JavaScript 2.5%
Other 2%
 
 
 
 
 
 
mk-personal-profile
main
testing
MK/conditional_fields
MK/meeting_checklist
all-inclusive
MK/finance_workflow
cm-oauth
MK/pdf_pagesize
cm-bump-4.2
cm-remove-jet
docu-new-group
toml-configuration-with-templates
individual-sender-address
changes-ku
authentik-integration
jenkins
object-level-permissions
dev
clubdesk-migration
docker
v1-0-stable
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '35e565d0bd'
${ noResults }
Go to file
Kasimir Uihlein 35e565d0bd Update and enhance documentation (#100) 
- Move documentation from README into sphinx docs
- change theme from alabaster to sphinxawsome-theme
- split into technical and user documentation
  - restructure docs/ directories
  - update sphinx refs in user documentation
- extend technical documentation with contributing page
- create seed for more technical documentation (architecture, deployment, testing)

Reviewed-on: #100
Reviewed-by: Christian Merten <christian@merten.dev>
Co-authored-by: Kasimir Uihlein <kuihlein@mailbox.org>
Co-committed-by: Kasimir Uihlein <kuihlein@mailbox.org>
 		11 months ago
docker tests: fix, generate html coverage report 12 months ago
docs Update and enhance documentation (#100) 11 months ago
jdav_web members/admin: add age list filter for waitinglist 11 months ago
.dockerignore docker: add test setup 3 years ago
.gitignore members/registration: pre-fill registration form 1 year ago
.gitmodules fix path of jet 4 years ago
Jenkinsfile ci: collect coverage report 3 years ago
Makefile Makefile/test: correct source path in coverage report 3 years 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