LowFAT User and Developer Guide

Welcome to the documentation of the Software Sustainability Institute’s Low effort Fellowship Administration Tool (lowFAT).

Users

Fellows

See tutorial for claimants

Staff

See tutorial for staff

Developers

LowFAT is open source, anyone can make a copy and add or remove features. For those looking to add (or remove) functionality from LowFAT they should follow this guide. For SSI staff, or external contributors, when working directly on the LowFAT repository, careful consideration should be paid to the workflow section to ensure adherence to our development practice. See developers section

License

LowFAT is licensed under the BSD 3-Clause License and by submiting any pull request to lowFAT you agree to make your contribution also avaiable under the BSD 3-Clause License.

Code Style

We follow PEP8.

Guides

To install LowFAT and start a local working server.

Setup

For testing on the local server including logging in as an admin or a user.

Testing

Before making changes please now familiarise yourself with the following information:

Now you should be ready to plan your update be it adding a feature, fixing a bug, or updating the styling. To ease the development cycle we impose the following process.

Development Cycle

For backing up the database in preparation for a site update.

Backup

Reuse and Redistribution

We wrote lowFAT to be one of our internal tools, but it is released under the BSD 3-Clause License and you are welcome to re-use it.

If you have any questions, please open an issue on GitHub.