bristol-su/api-client

An API Client for interacting with the Bristol SU Portal

dev-initial-setup 2020-09-04 18:34 UTC

Requires

• php: ^7.2
• ext-json: *
• bristol-su/api-client-toolkit: dev-develop

Suggests

• bristol-su/control-api-client: Extension to the API client for making requests to Control
• flyerless/flyerless-club-management-api-client: A Flyerless Api Client extension to allow access to club details
• guzzlehttp/guzzle: A psr compliant HTTP client for making requests
• symfony/cache: Allows for psr-16 compliant caching of HTTP results

MIT

• Toby Twigger

README

Static Page

A simple page to display predefined HTML to users
Explore the docs »

View Portal · Report Bug · Request Feature

Table of Contents

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

About The Module

This module shows predefined HTML to the user.

• Fully-featured WYSIWGY editor for defining the page
• Track page views
• Allow for a button to mark the module as complete

Getting Started

All you need to do to get started using this module is pull it into the portal or the playground!

composer require bristol-su/static-page

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 - [e-mail]

Project Link: https://github.com/bristol-su/static-page