Bristol SU Support Package Documentation

Portal SDK

The SDK on which the portal is built
Explore the docs »

View Portal · Report Bug · Request Feature

https://github.com/bristol-su/support/blob/master/LICENCE.md "![MIT License][license-shield]"

Table of Contents

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

About The Project

The SDK makes up the core functionality of the Bristol SU Portal.

Getting Started

Usually, you will want to use the portal package. If you're building an integration with the portal, run the following command to install.

composer require bristol-su/support

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/support