README.rst

Summary

Maintainability
Test Coverage
**********
Intranet 3
**********
.. image:: https://github.com/tjcsl/ion/workflows/CI/badge.svg?branch=master
    :target: https://github.com/tjcsl/ion/actions
    :alt: CI

.. image:: https://coveralls.io/repos/tjcsl/ion/badge.svg?branch=master&service=github
    :target: https://coveralls.io/github/tjcsl/ion?branch=master
    :alt: Coverage

*Version 3.0.0*

Intranet3 (Ion) is the next-generation Intranet platform for `TJHSST 
<https://tjhsst.fcps.edu/>`_. Using Python, Django, Redis, Postgres, and many other technologies, Ion was developed from the ground up to be simple, well-documented, and extensible.

Documentation (in RestructuredText format) is available inside the "docs" folder or at https://tjcsl.github.io/ion publicly on the web.

**What does the TJ Intranet do?** Ion allows students, teachers, and staff at TJHSST to access student information, manage activity signups for TJ's Eighth Period program, and view information on news and events. `Read more about how Ion is used at Thomas Jefferson <https://ion.tjhsst.edu/about>`_.

**Ion now requires Python 3.8+** Python 3.8.5 is currently used in both production and testing environments.

**How can I create a testing environment?** Read the section on `Setting up a Dev Environment <https://github.com/tjcsl/ion/blob/master/SETUP.md>`_ in the documentation.

**How can I contribute to Ion? How can I report a bug? How can I report a security issue/vulnerability?**

Please read our `contributing guide <https://github.com/tjcsl/ion/blob/master/CONTRIBUTING.md>`_ for more information.

Current Intranet maintainers: `alanzhu0 <https://github.com/alanzhu0>`_ and `NotFish232 <https://github.com/NotFish232>`_