Display comprehensive help and documentation for the Odoo PWA Generator plugin.
Displays comprehensive help and documentation for the Odoo PWA Generator plugin with command reference and workflows.
/plugin marketplace add jamshu/jamshi-marketplace/plugin install odoo-pwa-generator@jamshi-marketplaceDisplay comprehensive help and documentation for the Odoo PWA Generator plugin.
The odoo-pwa-generator plugin helps you create offline-first Progressive Web Apps with Odoo Studio backend integration. It supports SvelteKit, React, and Vue frameworks.
⨠Quick Project Generation - Create complete PWAs in minutes š± Offline-First - Smart caching with background sync š Odoo Integration - Seamless Odoo Studio connectivity š Production Ready - Pre-configured deployment setups ā” Framework Support - SvelteKit, React, and Vue
Create new PWA projects:
/new-svelte-pwa - Generate SvelteKit PWA/new-react-pwa - Generate React PWA/new-vue-pwa - Generate Vue PWA/add-model - Add Odoo model to existing PWA/create-cache-store - Create cache store for a modelDevelopment and deployment:
/init-project - Initialize new PWA project/setup-env - Configure environment variables/test-connection - Test Odoo API connection/deploy-vercel - Deploy to Vercel/deploy-github - Deploy to GitHub PagesHelp and reference:
/help - This help document (you are here!)/examples - Real-world usage examples/architecture - Explain PWA architecture/api-reference - Odoo API client documentation/troubleshoot - Common issues and solutionsProject management:
/update-deps - Update project dependencies/fix-sync - Diagnose and fix sync issues/clear-cache - Clear application caches/add-deployment - Add new deployment target/optimize - Run optimization checks1. /new-svelte-pwa (or /new-react-pwa or /new-vue-pwa)
2. Provide project details (name, model, etc.)
3. /init-project
4. Start coding!
1. /setup-env
2. Provide Odoo credentials
3. /test-connection
4. Verify everything works
1. /add-model
2. Specify model name and details
3. Test CRUD operations
4. Customize UI as needed
1. /deploy-vercel (recommended)
OR /deploy-github
2. Configure environment variables
3. Test deployed application
4. Set up custom domain (optional)
1. /test-connection - Check Odoo connectivity
2. /troubleshoot - Find specific solutions
3. /fix-sync - Diagnose sync problems
4. /clear-cache - Reset if needed
Choose your framework and run the appropriate command:
/new-svelte-pwa
When prompted, provide:
cd your-project-name
/init-project
/setup-env
Provide your Odoo URL, database, API key, and username.
/test-connection
Verify your Odoo connection works correctly.
The dev server should be running. Open your browser and start customizing!
/deploy-vercel
Follow the prompts to deploy to production.
Generates a complete PWA project from scratch.
When to use: Starting a new project
What it generates:
Adds integration for additional Odoo models.
When to use: Adding new data models to existing project
What it generates:
Creates a standalone cache store.
When to use: Need custom caching logic
What it generates:
.env file (never commit)/help - Show this help documentREADME.md - Getting started guideCLAUDE.md - Architecture patternsAPI.md - API client referenceIf you encounter issues:
/test-connection to diagnose/troubleshoot for common solutionsFor bugs or feature requests:
Component ā Cache Store ā API Client ā Server Route ā Odoo
id > lastRecordIdš” Use the right command for the job
/new-svelte-pwa/help or /troubleshoot/deploy-vercelš” Test early and often
/test-connection after setupš” Read the generated docs
š” Customize to your needs
š” Deploy with confidence
The odoo-pwa-generator plugin makes it easy to create production-ready PWAs with Odoo integration. Use the commands above to generate, develop, deploy, and maintain your applications.
For more details on any command, just run that command and follow the prompts!
Happy coding! š