michelegiorgi / formality

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

Formality

New plugin website  |  Wordpress.org page  |  Donate link
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 or directly install it from the plugins page in your WordPress admin.

Requirements

• WordPress >= 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 workflow/build process.
Make sure all dependencies have been installed before moving on:

• Node.js >= 16.0.0
• Yarn
• WP-CLI

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