README

Control

The user management system used by the Bristol SU Portal
Explore the docs »

View Portal · Report Bug · Request Feature

Table of Contents

• About the Project
• Getting Started
• Roadmap
• Contributing
• License
• Contact

About The Project

The control package provides a set of interfaces for creating a user management system, including groups and roles.

It also provides a database implementation of these interfaces, leading to a zero-configuration package. Additionally, it provides a full API for accessing and changing data.

Getting Started

Usually, you will want to use the portal package. This package is included with the SDK, but to pull it in alone, run

composer require bristol-su/control

See our developer docs for more information.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, be inspired, and create. Any contributions you make are greatly appreciated.

1. Create an issue to notify us of your planned changes
2. Fork the Project
3. Create your Feature Branch (git checkout -b feature/AmazingFeature)
4. Commit your Changes (git commit -m 'Add some AmazingFeature')
5. Push to the Branch (git push origin feature/AmazingFeature)
6. Open a Pull Request to the Development Branch

See CONTRIBUTING for more information.

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

Contact

Toby Twigger - toby.twigger@bristol.ac.uk

Project Link: https://github.com/bristol-su/control