CoronAlert

Table of contents

• Important links
• Bugs and feature requests
• Install
• Install and usage
• Documentation
• Contributing
• Authors and contributors
• Copyright and license

Important links

• CoronAlert homepage
• Official source code repo
• Documentation
• Issue tracker

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Install and usage

See this guide to install the CoronAlert API using Docker. There are also a few usage commands to get you started.

Documentation

The documentation of the CoronAlert API can be found at docs.coronalert.nl.

We use Sphinx to create the documentation. The source files are included in this repo under the docs directory.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Authors and contributors

The CoronAlert API is based on the Open Raadsinformatie API. Authors and contributors of both projects are:

Authors:

• Bart de Goede (@bartdegoede)
• Justin van Wees (@justin_v_w)
• Breyten Ernsting (@breyten)
• Sicco van Sas(@siccovansas)

Contributors:

• DutchCoders
• Benno Kruit

Copyright and license

The CoronAlert API is distributed under the GNU Lesser General Public License v3. The documentation is released under the Creative Commons Attribution 4.0 International license.