bristol-su/api-client

An API Client for interacting with the Bristol SU Portal

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

This package is auto-updated.

Last update: 2020-11-04 18:49:35 UTC


README

Logo

Static Page

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

View Portal · Report Bug · Request Feature

Build Code Quality Release MIT License

Downloads Stargazers Issues

Table of Contents

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 - toby.twigger@bristol.ac.uk

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