YSFStart

🚀 Create Spring Boot projects instantly - Works like Laravel's laravel new command

npm install -g ysfstart
ysfstart my-project

⚡ Quick Start

# Install
npm install -g ysfstart

# Create a project
ysfstart my-api

# Run it
cd my-api
./mvnw clean verify
docker-compose up

✨ What You Get

• ✅ Clean Architecture - Presentation / Application / Domain / Infrastructure layers
• ✅ Spring Boot 3.x + Java 17
• ✅ PostgreSQL with Docker Compose
• ✅ OpenAPI/Swagger docs
• ✅ Tests included - JUnit 5 + Mockito
• ✅ Production ready - Best practices included

📦 Requirements

• Node.js 14+ (for the CLI tool)
• Java 17+ (for the generated project)
• Docker (optional, for database)

🎯 Usage

# Basic
ysfstart my-project

# Show help
ysfstart --help

📁 Generated Project

Your new project includes:

my-project/
├── src/
│   ├── main/java/                # Your code
│   │   ├── presentation/         # REST controllers
│   │   ├── application/          # Business logic
│   │   ├── domain/               # Entities
│   │   └── infrastructure/       # Database
│   └── resources/
│       └── application.yml       # Config
├── pom.xml                       # Dependencies
├── docker-compose.yml            # Database
└── README.md

🏃 Running Your Project

cd my-project

# With Docker (recommended)
docker-compose up

# Or just tests
./mvnw clean verify

Visit: http://localhost:8080/swagger-ui.html

🛠️ For Developers

Want to understand how this works?

Read LEARN.md - Simple explanation of the 3 core files

📦 Publishing Your Own

1. Create account at npmjs.com
2. Update package.json with your name
3. Run:

   npm login
   npm publish

📄 License

MIT License - See LICENSE file

Questions? Read LEARN.md to understand how it works!