About open-forms

Smart and dynamic forms

o

Published by

open-formulieren

Visit View Profile

README.md

View on GitHub

========== Open Forms

.. image:: .github/assets/open-formulieren-logo.svg :height: 100px :alt: Open Forms

:Version: 4.0.0-alpha.0 :Source: https://github.com/open-formulieren/open-forms :Keywords: e-Formulieren, Common Ground, FormIO, API

|docs| |docker|

Easily create and publish smart forms (Nederlandse versie_)

Developed by Maykin B.V., originally commissioned by Dimpact.

Introduction

Using Open Forms, administrators can quickly create powerful and smart forms that are exposed via an API. With the Open Forms JavaScript SDK_, personalized forms can be retrieved and shown to the user. The form blends in with an existing website using various styling options. Form fields are pre-filled whenever possible and personalized choices are shown depending on the user, if authenticated.

Using a plugin-based architecture, Open Forms allows for flexible submission backends (e.g. Open Zaak_), authentication schemes, payment providers, calendar apps and pre-fill services.

Open Forms is developed in line with the Common Ground_ principles, with many plugins for government usage and with a strong focus on usability for both end users and administrators.

.. image:: docs/introduction/_assets/open-forms-from-designer-to-form.png :width: 100%

.. SDK: https://github.com/open-formulieren/open-forms-sdk/ .. Common Ground: https://commonground.nl/ .. _Open Zaak: https://open-zaak.readthedocs.io/

Component

This component includes the Open Forms Admin UI and the Open Forms API.

API Specifications

These can be found in the documentation <https://open-forms.readthedocs.io/en/latest/developers/versioning.html#open-forms-api>_

References

Documentation <https://open-forms.readthedocs.io/>_
Community <https://commonground.nl/groups/view/0c79b387-4567-4522-bc35-7d3583978c9f/open-forms>_
Docker image <https://hub.docker.com/r/openformulieren/open-forms>_
Issues <https://github.com/open-formulieren/open-forms/issues>_
Code <https://github.com/open-formulieren/open-forms>_
Open Forms SDK <https://github.com/open-formulieren/open-forms-sdk>_

Licence

Licensed under the EUPL_.

.. Nederlandse versie: README.NL.rst .. Maykin B.V.: https://www.maykin.nl .. Dimpact: https://www.dimpact.nl .. "the Stakeholders": STAKEHOLDERS.md .. _EUPL: LICENSE.md

.. |build-status| image:: https://github.com/open-formulieren/open-forms/actions/workflows/ci.yml/badge.svg :alt: Build status :target: https://github.com/open-formulieren/open-forms/actions/workflows/ci.yml

.. |code-quality| image:: https://github.com/open-formulieren/open-forms/actions//workflows/code_quality.yml/badge.svg :alt: Code quality checks :target: https://github.com/open-formulieren/open-forms/actions//workflows/code_quality.yml

.. |docs| image:: https://readthedocs.org/projects/open-forms/badge/?version=latest :target: https://open-forms.readthedocs.io/en/latest/?badge=latest :alt: Documentation status

.. |coverage| image:: https://codecov.io/github/open-formulieren/open-forms/branch/main/graphs/badge.svg?branch=main :alt: Coverage :target: https://codecov.io/gh/open-formulieren/open-forms

.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json :target: https://github.com/astral-sh/ruff :alt: Ruff

.. |docker| image:: https://img.shields.io/docker/v/openformulieren/open-forms?sort=semver :alt: Docker image :target: https://hub.docker.com/r/openformulieren/open-forms

.. |python-versions| image:: https://img.shields.io/badge/python-3.12-blue.svg :alt: Supported Python versions

open-forms