Antidote.FormStudio 0.0.3

Antidote.FormStudio 🔥

Antidote.FormStudio is a powerful drag-and-drop form builder library built on top of Fable.Form, designed to simplify the creation of dynamic forms for web applications developed with Fable.js.

Status

We have been using this tool in production for a while now, but we've recently decoupled it from our solution to be able to share it with you. That said, this tool as a stand-alone package still has some rough edges and considered a pre-release. We are planning on fixing issues and will keep adding features to it for the forseable future.

Dependencies

There's a few related projects in which Antidote.Form studio depends. Most can be used stand-alone for various purposes. Explore our repositories within antidote-org github organization for more details.

Features

• 🫳 Intuitive Drag-and-Drop Interface: Easily design forms by dragging various field types onto a canvas.
• 🛠️ Versatile Field Support: Supports a wide range of HTML fields and custom field types including signatures, images, and more.
• ⚙️ Form Customization: Allows users to define steps, calculate field values, and perform validations based on field types.
• 🗣️ Special Text To Speech field: There's a special text-area field with support for voice dictation.
• 🤖 AI transcription cleanup: The same TTS field above has support for transcription evaluation using ChatGPT. You must provid your own API key.
• 👁️ Preview Functionality: Provides a preview/playground feature to visualize and test the generated form.
• 🧾 Result Output: The result can be either a sophisticated, type-safe schema based on the supporting Antidote.FormStudioSpec, or a simple json result ready. This output can be easily customizable to your specific needs.
• 🤝 Compatible with Fable.js: Seamlessly integrates with Fable.js for efficient web application development. - it should be compatible with any react app, because fablejs 🤩, but I don't currently have the time tinker with that atm.
• 🌍 Multi-lingual support (wip): We have added a support for english, spanish and french for the UI, and can leverage external translations for your domain's questions and answers. It's somewhat incomplete, but but we're trying to improve on this front and we have auto-translation through external APIs.
• ⬇️ Option generation: Fields that support multiple choices can be easily provided to the field via a simple csv file upload.

Roadmap

• Package Stabilization: Our first priority is to make sure the package can be used with confidence

• Test Suite: In making the avove possible, we wish to add 100% test coverage. There's none atm 😢

• Plugin Support: We want to make it easy for the developers to add their own custom fields in the form of plugins

• Complete Multi-Lingual support: Full support for languages in the entire UI, and generic support for external translation resources to the form's questions and answers.

Getting Started

The package is available in two forms:

• Simply clone the repo and make it accessible to your project
• Add a package reference using paket/nuget

To integrate Antidote.FormStudio into your Fable.js project using, follow these steps:

1. Install the Antidote.FormStudio library via paket/nuget and use femto to resolve dependencies:

   dotnet paket install Antidote.FormStudio
   dotnet femto --resolve
   

2. Import the library into your Fable.js project:

   open Antidote.FormStudio.DynamicFormDesigner
   

3. Create an instance of the component

   DynamicFormDesigner StandAlone
   

Sample App

Explore the Antidote.FormStudio Sample App repository to see a working example of Antidote.FormStudio in action. This sample app showcases how the library can be integrated into a Fable.js project and utilized to build dynamic forms. The basic Feliz app template was used to generate this sample

Contributing

PRs are welcome!

Thanks

We want to express our gratitude to everyone who has contributed to the development of the Fable ecosystem and hope that Antidote.FormStudio is as useful and valuable to the community and feedback is ALWAYS greatly appreciated.

There are countless souls that have contributed and helped through out our journey, and the plethora of tools in the React ecosystem as well, since the project depends on a number of OSS projects! Thank you all!...

Special thanks go out to:

@mangelmaxime has been a tremendous source of inspiration and a great mentor to our team, THANK YOU!! 🍻 (... and let's not forget, without Fable.Form, Thoth.Json, Glutinum bindings, etc, etc, etc this tool would probably not exist!)

@tpetricek we've gotten through TOUGH problems with his knowledge, wisom and advice 🤓

@zaid-ajaj for his many contributions to the community... we ❤️ Feliz!

@alfonsogarciacaro for fablejs, what an amazing library! 👏

@dsyme goes without saying... we rekindled our love with programming only because F# 🙏

Your support is greatly appreciated

Whether through code contributions, bug reports, feature suggestions, or feedback. Your support is invaluable in making this project better for the community.

License

This library is licensed under the MIT License.

Thank you for using Antidote.FormStudio! We hope it simplifies your form-building experience in Fable.js projects - Team Antidote.

*** This is our first project to open-source (hopefully the first of many), and it was a bit of a headache getting all most of the dependencies and nuget packages ready for consuption. Our apologies if we've made mistakes in the way we released it. If you have advice on how to improve this process, please share your thoughts!