NetEvent
==================================================

|NetEvent_test_and_build| |Lines of Code| |Quality Gate Status|
|Duplicated Lines (%)| |Coverage| |Maintainability Rating| |Reliability
Rating| |Security Rating| |Vulnerabilities| |Code Smells| |Bugs| |Client Translation|

is an open source software solution for organizing events, especially focused on lan partys.

Its currently under heavy development, so only use it for testing or development.


.. toctree::
   :maxdepth: 2

   contribution
   license

.. toctree::
   :caption: Users guide
   :maxdepth: 2

   user/start
   
.. toctree::
   :caption: Admins guide
   :maxdepth: 1

   admin/quickstart
   admin/reverseproxy

   
.. toctree::
   :caption: Developers guide
   :maxdepth: 1

   develop/quickstart
   develop/database
   develop/folderstructure
   develop/models
   develop/services
   develop/permissions
   develop/authenticationsystem
   develop/cicd
   develop/release
   develop/translation

.. |NetEvent_test_and_build| image:: https://github.com/Lan2Play/NetEvent/actions/workflows/test_and_build.yml/badge.svg
   :target: https://github.com/Lan2Play/NetEvent/actions/workflows/test_and_build.yml
.. |Lines of Code| image:: https://sonarcloud.io/api/project_badges/measure?project=Lan2Play_NetEvent&metric=ncloc
   :target: https://sonarcloud.io/summary/new_code?id=Lan2Play_NetEvent
.. |Quality Gate Status| image:: https://sonarcloud.io/api/project_badges/measure?project=Lan2Play_NetEvent&metric=alert_status
   :target: https://sonarcloud.io/summary/new_code?id=Lan2Play_NetEvent
.. |Duplicated Lines (%)| image:: https://sonarcloud.io/api/project_badges/measure?project=Lan2Play_NetEvent&metric=duplicated_lines_density
   :target: https://sonarcloud.io/summary/new_code?id=Lan2Play_NetEvent
.. |Coverage| image:: https://sonarcloud.io/api/project_badges/measure?project=Lan2Play_NetEvent&metric=coverage
   :target: https://sonarcloud.io/summary/new_code?id=Lan2Play_NetEvent
.. |Maintainability Rating| image:: https://sonarcloud.io/api/project_badges/measure?project=Lan2Play_NetEvent&metric=sqale_rating
   :target: https://sonarcloud.io/summary/new_code?id=Lan2Play_NetEvent
.. |Reliability Rating| image:: https://sonarcloud.io/api/project_badges/measure?project=Lan2Play_NetEvent&metric=reliability_rating
   :target: https://sonarcloud.io/summary/new_code?id=Lan2Play_NetEvent
.. |Security Rating| image:: https://sonarcloud.io/api/project_badges/measure?project=Lan2Play_NetEvent&metric=security_rating
   :target: https://sonarcloud.io/summary/new_code?id=Lan2Play_NetEvent
.. |Vulnerabilities| image:: https://sonarcloud.io/api/project_badges/measure?project=Lan2Play_NetEvent&metric=vulnerabilities
   :target: https://sonarcloud.io/summary/new_code?id=Lan2Play_NetEvent
.. |Code Smells| image:: https://sonarcloud.io/api/project_badges/measure?project=Lan2Play_NetEvent&metric=code_smells
   :target: https://sonarcloud.io/summary/new_code?id=Lan2Play_NetEvent
.. |Bugs| image:: https://sonarcloud.io/api/project_badges/measure?project=Lan2Play_NetEvent&metric=bugs
   :target: https://sonarcloud.io/summary/new_code?id=Lan2Play_NetEvent
.. |Client Translation| image:: https://translate.lan2play.de/widgets/netevent-client/-/netevent-client/svg-badge.svg
    :alt: Client Translation status
    :target: https://translate.lan2play.de/engage/netevent-client/



Users quickstart note
----------------------
- If you just want to use NetEvent as a user go to :doc:`/user/start`
- If you want to deploy NetEvent, please take a look into the :doc:`/admin/quickstart`
- If you want to help with the translation of NetEvent, please check out our :doc:`/develop/translation` section


Developer note
----------------------
- Github url: https://github.com/Lan2Play/NetEvent
- If you want to contribute to NetEvent, please take a look into the :doc:`/develop/quickstart`
- If you want to help with the translation of NetEvent, please check out our :doc:`/develop/translation` section

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`