https://github.com/michelegiorgi/formality

Forms made simple (and cute). Designless, multistep, conversational, secure, all-in-one WordPress forms plugin.
https://github.com/michelegiorgi/formality

block-editor form gutenberg gutenberg-blocks javascript js multistep php plugin react wordpress wordpress-plugin

Last synced: 3 months ago
JSON representation

Forms made simple (and cute). Designless, multistep, conversational, secure, all-in-one WordPress forms plugin.

• Host: GitHub
• URL: https://github.com/michelegiorgi/formality
• Owner: michelegiorgi
• License: gpl-3.0
• Created: 2020-04-05T09:46:45.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-02-28T20:00:47.000Z (over 1 year ago)
• Last Synced: 2024-06-21T11:28:12.795Z (5 months ago)
• Topics: block-editor, form, gutenberg, gutenberg-blocks, javascript, js, multistep, php, plugin, react, wordpress, wordpress-plugin
• Language: JavaScript
• Homepage: https://formality.dev
• Size: 44.9 MB
• Stars: 93
• Watchers: 6
• Forks: 16
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-starred - michelegiorgi/formality - Forms made simple (and cute). Designless, multistep, conversational, secure, all-in-one WordPress forms plugin. (js)

README

        
[![Formality](https://formality.dev/download/logo-github-2.svg)](https://formality.dev)

# Formality ![license](https://img.shields.io/github/license/michelegiorgi/formality?color=%230A01B3&style=flat-square) ![license](https://img.shields.io/github/v/release/michelegiorgi/formality?color=%230A01B3&style=flat-square)  

**[New plugin website](https://formality.dev)**  |  [Wordpress.org page](https://wordpress.org/plugins/formality)  |  [Donate link](https://www.paypal.me/michelegiorgi/)  

Designless, multistep, conversational, secure, all-in-one WordPress forms plugin.  

## Welcome

Welcome to the official **Formality repository** on GitHub. Here you can browse the source, look at open issues and keep track of development.

If you are not a developer, please download the latest release of the Formality plugin from the [WordPress.org plugins repository](https://wordpress.org/plugins/formality) or directly install it from the plugins page in your WordPress admin.

## Requirements

* [WordPress](https://wordpress.org/) >= 6.1

## Plugin setup

* Create a `formality` folder in your `wp-content/plugins` dir

* Copy the entire repository into your `formality` folder

* Activate it from wp-admin (like any other plugin)

## Assets build process

Based on [Sage](https://roots.io/sage/) workflow/build process.  

Make sure all dependencies have been installed before moving on:

* [Node.js](http://nodejs.org/) >= 16.0.0

* [Yarn](https://yarnpkg.com/en/docs/install)

* [WP-CLI](https://wp-cli.org)

### Setup

* Run `yarn` from the plugin directory to install dependencies

* Update `webpack.mix.js` settings:

  * `devUrl` should reflect your local development hostname

### Build commands

* `yarn start` — Compile assets when file changes are made, start Browsersync session

* `yarn build` — Compile and optimize the files in your assets directory

* `yarn build:production` — Compile assets for production

* `yarn download` — Create a lightweight plugin copy that includes only executable files and production assets

* `yarn release` — Create a lightweight plugin copy ready for WordPress.org Plugin SVN Repository

* `yarn i18n:pot` — Scans PHP and JavaScript files for translatable strings and create POT language file.

* `yarn i18n:json` — Extract JavaScript strings from PO files and add them to individual JSON files.

## Documentation

Soon

## Contributing

Contributions are welcome from everyone.

## License

GPL-3.0 - Copyright (c) 2018-2023 Michele Giorgi