README

Typeform

An integration with Typeform to show and collect results directly through the Portal.
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 allows Typeforms to be seamlessly embedded within the portal, letting you use the power of the Typeform platform alongside the flexibility of the Portal

• Embed a Typeform in a page
• Collect and review results
• Mark as complete after submissions

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

You should also add the following to your .env file if you haven't already

TYPEFORM_CLIENT_ID=
TYPEFORM_CLIENT_SECRET=

These can be generated through the developer apps setting in Typeform.

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