Skip to content
This repository has been archived by the owner on Dec 22, 2023. It is now read-only.
/ gincko Public archive

Build complex, smart forms or inputs-based UIs in seconds.

License

Notifications You must be signed in to change notification settings

openizr/gincko

Repository files navigation

⚠️ Please use @perseid/form instead

This NPM package is deprecated and no longer maintained. @perseid/form is the new official repository.

Build complex, smart forms or inputs-based UIs in seconds.

Build Status Coverage Status npm node Downloads

Table of Contents

  1. Installation
  2. Features
  3. Documentation
  4. Contributing
  5. Sponsor
  6. Maintainers
  7. License

Installation

yarn add gincko

Features

Building user interfaces containing multiple inputs is very repetitive and low-value process. It always contains the same logic, and doesn't fundamentally change much accross apps and websites: we need to implement different types of fields, fields validations logic, transitions, manage form submission, and so on. Why should we always go back to that each time we create a new feature?

gincko is meant to remove these unecessary, time-consuming parts, by providing a common, generic engine that automatically performs usual checks. Through a simple JSON-like configuration, you can generate deep, complex UIs, without a line of code, so you can focus on the real value of your project.

gincko can be used for a wide variety of use cases, including:

  • Forms, surveys
  • Profile / settings edition pages, blog post creation, ...
  • Contact or support page with ticket creation
  • And even chatbots or FAQs!

Why choosing gincko to develop your project?

  • Small learning curve, simple concepts
  • Tiny JSON configuration for basic use cases
  • Completely dynamic form steps generation, based on previous inputs
  • Fully extensible and customizable for most complex use cases, using plugins
  • Supports React, Svelte and Vue natively, although you can also provide your own implementation for them or any other frontend framework

Documentation

The complete documentation is available here

Contributing

You're free to contribute to this project by submitting issues and/or pull requests. For more information, please read the Contribution guide.

Sponsor

Love this project and want to support it? You can buy me a coffee :)

Or just sending me a quick message saying "Thanks" is also very gratifying, and keeps me motivated to maintain open-source projects I work on!

Maintainers


Matthieu Jabbour

License

MIT

Copyright (c) Openizr. All Rights Reserved.