Forms Pro

bench get-app https://github.com/BuildWithHussain/forms_pro

[![Listed on Frappe Gems](https://frappegems.com/api/method/frappe_gems.seo.badge?app=BuildWithHussain%2Fforms_pro)](https://frappegems.com/gems/apps/BuildWithHussain/forms_pro)

--- ## ✨ Features - 🎨 **Modern Drag-and-Drop Builder** - Intuitive visual form builder with real-time preview - 📝 **Rich Field Types** - Support for Data, Number, Email, Date, DateTime, DateRange, TimePicker, Password, Select, Switch, Textarea, and Text Editor fields - 🔗 **Doctype Integration** - Link forms to any Frappe DocType for seamless data management - 👥 **Team Collaboration** - Built-in team support for multi-user form management - 🔐 **Access Control** - Optional login requirements and permission management - 💾 **Save Progress** - Allow incomplete submissions with save-and-continue functionality - 🎯 **Custom Routes** - Publish forms with custom URLs for easy sharing - 📱 **Responsive Design** - Beautiful, mobile-friendly forms that work everywhere - ⚡ **Real-time Updates** - Built with Vue 3 and modern web technologies for smooth performance ## 🖼️ Preview ## 🚀 Installation Forms Pro is a Frappe app and can be installed using the [bench](https://github.com/frappe/bench) CLI. ### Prerequisites - Frappe Framework installed via bench - Python 3.14 or higher - Node.js and npm/yarn (for frontend development) ### Install via Bench ```bash cd $PATH_TO_YOUR_BENCH bench get-app https://github.com/buildwithhussain/forms_pro --branch develop bench install-app forms_pro ``` ### Development Setup For development, you'll need to set up the frontend: ```bash cd apps/forms_pro/frontend yarn install yarn dev # For development yarn build # For production build ``` ## 📖 Usage 1. **Create a Form**: Navigate to Forms Pro in your Frappe desk 2. **Add Fields**: Use the drag-and-drop builder to add and arrange form fields 3. **Configure Settings**: Set up form title, description, linked doctype, and other settings 4. **Publish**: Enable "Is Published" and set a custom route 5. **Share**: Share your form URL with users ### Form Builder Features - **Drag and Drop**: Reorder fields by dragging them in the builder - **Field Properties**: Customize each field's label, type, validation, and options - **Live Preview**: See your form as you build it - **Rich Text Description**: Add formatted descriptions using the text editor ## 🛠️ Tech Stack - **Backend**: Python 3.14+, Frappe Framework - **Frontend**: Vue 3, TypeScript, Vite - **UI Components**: Frappe UI, Tailwind CSS - **Form Builder**: Vue Draggable - **Validation**: Zod - **Icons**: Lucide Vue, Feather Icons ## 🤝 Contributing We welcome contributions! Forms Pro uses `pre-commit` for code formatting and linting. Please review [`CONTRIBUTING.md`](CONTRIBUTING.md) for the contribution workflow and [`SECURITY.md`](SECURITY.md) for responsible disclosure. ### Setup for Contribution 1. **Fork the repository** and clone your fork 2. **Install pre-commit**: ```bash cd apps/forms_pro pre-commit install ``` 3. **Create a branch** for your changes: ```bash git checkout -b feature/your-feature-name ``` 4. **Make your changes** and ensure they pass linting: ```bash pre-commit run --all-files ``` 5. **Submit a pull request** with a clear description of your changes ### Code Quality Tools This project uses the following tools for code quality: - **ruff** - Python linter and formatter - **eslint** - JavaScript/TypeScript linter - **prettier** - Code formatter - **pyupgrade** - Python syntax upgrades - **biome** - Fast formatter and linter for frontend ## 🧪 Testing The project includes automated testing via GitHub Actions: - **CI**: Installs the app and runs unit tests on pull requests and pushes to `develop` - **Linters**: Runs [Frappe Semgrep Rules](https://github.com/frappe/semgrep-rules) and [pip-audit](https://pypi.org/project/pip-audit/) on every pull request ### Running Tests Locally The test suite uses [frappe_factory_bot](https://github.com/harshtandiya/frappe_factory_bot) for test data factories. You must install it on your bench before running tests. **1. Install frappe_factory_bot:** ```bash cd $PATH_TO_YOUR_BENCH bench get-app https://github.com/harshtandiya/frappe_factory_bot.git --branch main bench --site install-app frappe_factory_bot ``` **2. Run the tests:** ```bash # Run all Forms Pro tests bench --site run-tests --app forms_pro # Run a specific test module bench --site run-tests --module forms_pro.tests.test_roles ``` ## 📄 License This project is licensed under the **AGPL-3.0** License - see the [LICENSE](LICENSE) file for details. ## 👥 Authors - **Harsh Tandiya** - [harsh@buildwithhussain.com](mailto:harsh@buildwithhussain.com) - **BWH Studios** - [developers@buildwithhussain.com](mailto:developers@buildwithhussain.com) ## 🙏 Acknowledgments - Built on the amazing [Frappe Framework](https://github.com/frappe/frappe) - Inspired by the Frappe community's need for better form building tools ---