Playground

A vital development tool for the portal, allowing you to instantly frame and edit a module. Change settings, permissions and third party connections and see how the module reacts.
Explore the docs »
Demo Site »

View Portal · Report Bug · Request Feature

Table of Contents

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

About The Project

This Laravel based site enables modules to be opened and edited instantly, providing a much more flexible sandbox than the portal.

Individual settings, permissions and third party connections can be changed for each module, and the effects instantly seen. Additionally, modules in the sandbox can be saved and shared, providing a collaborative environment for building modules.

We recommend using the playground to learn how different modules work and what settings/permissions you should have for your modules in the portal.

Getting Started

Clone the package to your computer.

git clone https://github.com/bristol-su/playground

Install the dependencies

composer install

Copy .env.example to .env and fill in required environment variables

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 - [email protected]

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