create-liferay-microservice-cx
v1.0.0
Published
Zero-config CLI to scaffold Liferay Microservice Client Extensions — Spring Boot-powered, OAuth2 secured, ready to deploy.
Maintainers
Readme
create-liferay-microservice-cx
⚡ Zero-config CLI to scaffold Liferay Microservice Client Extensions in seconds.
Quick Start
npx create-liferay-microservice-cx my-service
cd my-service
./gradlew build
./gradlew deployWhat You Get
- ✅ Spring Boot microservice (Java-based)
- ✅ OAuth2 secured endpoints
- ✅ client-extension.yaml pre-configured for all environments
- ✅ Multi-environment support (local, QA, UAT, production)
- ✅ Gradle build system with Liferay integration
- ✅ Ready to deploy to Liferay 7.4+ / DXP
Usage
Interactive Mode
npx create-liferay-microservice-cxWith Arguments
npx create-liferay-microservice-cx my-service \
--org com.mycompany \
--oauth-app my-service-oauth \
--app-title "My Service" \
--port 58081 \
--author "Laxit Khanpara" \
--email "[email protected]"Options
| Flag | Description | Default |
|------|-------------|---------|
| --name, -n | Project name (kebab-case) | (prompted) |
| --org, -o | Organization (Java package) | (prompted) |
| --oauth-app | OAuth application name | (prompted) |
| --app-title | Application display title | (auto-generated) |
| --port | Server port | 58081 |
| --author | Author name | Your Name |
| --email | Author email | (prompted) |
| --help, -h | Show help | — |
| --version, -v | Show version | — |
Requirements
- Node.js ≥ 18.0.0
- npm ≥ 9.0.0
- Java ≥ 11
- Gradle ≥ 7.0
- Liferay Workspace (for deployment)
After Scaffolding
- Navigate into your project:
cd my-service - Build:
./gradlew build - Deploy to Liferay:
./gradlew deploy
Documentation
📖 Full documentation: GitHub Repository
Links
License
MIT © Laxit Khanpara
