LiteSurveys WordPress Plugin

Add simple one-question surveys to your WordPress site to gather feedback from your visitors. LiteSurveys is a lightweight plugin that helps you create unobtrusive slide-in surveys that appear at the perfect moment.

Installation

The ideal method is to use the WordPress Plugin Repository to install directly into your WordPress site.

However, you can also manually install from this GitHub repo using the following steps:

1. Download the latest release from the releases page
2. Go to your WordPress admin panel
3. Navigate to Plugins > Add New
4. Click "Upload Plugin" and select the downloaded zip file
5. Click "Install Now" and then "Activate"
6. Go to LiteSurveys in your WordPress admin menu to create your first survey

Development Setup

1. Clone this repository
2. Install PHP dependencies: composer install
3. Install Node dependencies: npm install
4. Run tests: composer test
5. Build assets: npm run build

Requirements

• PHP 8.0 or higher
• WordPress 6.1 or higher
• Node.js 20.x (for development)
• Composer (for development)

Contributing

Community made feature requests, patches, localizations, bug reports, and contributions are always welcome.

Creating Issues

• Please create issues for bugs or feature requests
• For bug reports, please clearly describe the bug/issue and include steps to reproduce
• For feature requests, please clearly describe what you would like, how it would be used, and example screenshots (if possible)

Pull Requests

• Ensure you stick to the WordPress Coding Standards
• When committing, reference your issue number and include a note about the fix
• Push the changes to your fork and submit a pull request to the main branch
• Each function should be documented with phpDoc standards
• Use tabs (not spaces) with a tab indent size of 4

Deployment

The deployment process is mostly automated for deploying changes to WordPress.org using GitHub actions.

When a commit is pushed to main, it:

1. Minifies CSS and JavaScript files
2. Generates translation files

Then, when a new GitHub release is created from the main branch, it:

1. Creates a new SVN tag on WordPress.org
2. Updates the plugin assets and readme on WordPress.org

Testing

The plugin includes comprehensive unit tests. Run them using:

composer test

License

This project is licensed under the GPLv3 License - see the LICENSE file for details.

Credits

Developed by Frank Corso

See also the list of contributors who participated in this project.