Skip to content

Repository files navigation

WPUI Frappe App Starter

This standalone React app starter demonstrates @lubusin/wp-frappe-data-store in a WordPress page shell. It uses WordPress DataViews for resource lists and DataForm for record editing. It connects to Frappe CRM and can browse, search, filter, create, edit, bulk-select, and delete its core records.

Caution

Project is currently under active development.

Quickstart

Prerequisites

  • Node.js 18 or newer
  • A running Frappe site with the CRM app installed, reachable at https://frappe.localhost (or another origin)
  • A Frappe user with appropriate CRM DocType permissions (Read, Write, Create, Delete)

Build & Run

From the root directory:

# Install workspace dependencies
npm install

# Start the standalone Vite development server
npm run dev

Then open http://127.0.0.1:5180 in your browser.

Connecting to Frappe: On startup, enter your Frappe site URL (defaults to https://frappe.localhost) and authenticate using either your Frappe Password or an API Token. Credentials are sent securely to Frappe and are never persisted in local storage.

Advanced Configuration & Deployment

This starter app includes several advanced configurations and deployment setups. Please refer to the Starter Templates Documentation for detailed guides on:

  • Authentication Options (Password session vs API Token)
  • Changing the Default Frappe URL (VITE_FRAPPE_TARGET)
  • Required Frappe Permissions
  • Cloudflare Pages Edge Deployment (Live demo hosting via Vite + Cloudflare functions)
  • Troubleshooting (Permission errors, Guest connections, etc.)

Development Commands

npm run dev         # Start local dev server
npm run build       # Build production bundle to dist/
npm run typecheck   # Run strict TypeScript checks
npm test            # Run Vitest unit tests

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Support

For issues and feature requests, please use the GitHub issue tracker.

Meet Your Artisans

LUBUS is a web design agency based in Mumbai.

License

WPUI Frappe App Starter is open-sourced licensed under the MIT License.

About

Standalone SPA App using frappe data store

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Sponsor this project

Packages

Contributors

Languages