TJ Intranet 3 (Ion)
Clone or download

README.rst

Intranet 3

Travis CI Code Climate Coverage Codacy Docs

Version 3.0.0

Intranet3 (Ion) is the next-generation Intranet platform for TJHSST. 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://ion.readthedocs.io 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, and view information on news and events. Read more about how Ion is used at Thomas Jefferson.

Ion now requires Python 3.4+ Python 3.4 is currently used in both production and testing environments. If you already have a Vagrant environment set up with Python 2, re-run config/provision_vagrant.sh to update dependencies.

How can I create a testing environment? Read the section on Setting up Vagrant in the documentation. Ask a TJ Sysadmin for VPN access and tokens needed to connect to our servers.

Why is my build failing? A PEP 8 syntax checker is run during the CI build. You can add a pre-commit hook to warn you about issues in your code by running flake8 --install-hook. Ensure that your code follows those guidelines by running this in the root of the repository: ./scripts/format.sh

Where can I report a bug?

  • Most bugs and feature requests should be submitted through GitHub Issues.
  • Security-related or TJ CSL-specific issues should be emailed to intranet@tjhsst.edu.

Current Intranet maintainers: James Houghton (TJ 2017) and Eric Wang (TJ 2017)