create-appsan-miniapp
v1.3.0
Published
CLI to scaffold Appsan MiniApp projects (backend & frontend starters)
Maintainers
Readme
create-appsan-miniapp
A CLI tool to scaffold Appsan MiniApp projects — both backend (Node.js/Express) and frontend (Angular or React) starters.
Quick Start
npx create-appsan-miniappOr install globally:
npm install -g create-appsan-miniapp
create-appsan-miniappWhat It Creates
Backend Starter
- Node.js / Express with ES Modules
- sw-backend-sdk integration with authentication middleware
- Flyway-style multi-schema database migration system
- App initializer with critical/non-critical step support
- Helm charts, Jenkinsfiles, Dockerfile, deployment YAML
- Environment-based configuration (development/production)
Frontend Starter (Angular)
- Angular project with @appsan-web/mini-web-sdk integration
- Complete ApiService with GET, POST, PUT, PATCH, DELETE, upload
- miniapp-config.json for base URL and allowed URLs
- Example pages with routing
Frontend Starter (React)
- React (Vite) project with @appsan-web/mini-web-sdk integration
- Complete apiService with all HTTP methods
- miniapp-config.json configuration
- Example pages with React Router
CLI Options
The CLI will interactively ask you:
- Project type: Backend or Frontend
- Project name: Name for your miniapp
- For Backend:
- Port number
- Whether to include Flyway migrations
- Whether to include the App Initializer
- Whether to include Helm/Jenkins CI/CD files
- Database URL (if migrations enabled)
- For Frontend:
- UI Framework: Angular or React
- Base API URL
- Whether to include example pages
Publishing to npm
npm login
npm publishLicense
MIT
