sprygen 1.0.0 → 1.0.3

package/README.md

@@ -1,80 +1,87 @@
-# Sprygen
+<div align="center">
+  <h1>🌱 Sprygen</h1>
+  <p><strong>A production-ready Spring Boot project generator CLI</strong></p>
+</div>
 
-A fully-functional project generator tool similar to JHipster, written in Node.js with TypeScript, that can scaffold Spring Boot projects with authentication and common modules pre-configured.
+Sprygen is an interactive CLI written in TypeScript that scaffolds secure, structured Java Spring Boot applications. It handles the boilerplate of authentication, role-based access control, database configuration, and optional frontends so you can focus on building features.
 
-## Features
+> Scaffold a full CRUD application with JWT auth, an admin panel, and Swagger docs in under 30 seconds.
 
-* **Generate Spring Boot Project**: Scaffolds a full Spring Boot 3.x project with Maven or Gradle.
-* **Pre-configured Auth**: Includes JWT authentication via Spring Security.
-* **Database Support**: Choose between H2 (in-memory), MySQL, or PostgreSQL.
-* **Optional Modules**: Switch on Swagger OpenAPI, Spring Mail, and custom Logback logging.
-* **Entity Generator**: Quickly add new JPA entities with full repository, service, and controller layers (CRUD REST API).
-* **Standalone Auth Generator**: Add JWT security configurations to any existing Spring Boot project.
+## ✨ Features
 
-## Installation
+- **Interactive Scaffolding:** Prompt-based setup for Java versions, build tools (Maven/Gradle), and databases (H2, MySQL, PostgreSQL).
+- **Built-in Security:** Choose between stateless JWT authentication for REST APIs or stateful Session-based authentication for traditional web apps.
+- **Role-Based Access Control:** Pre-configured `ROLE_ADMIN` and `ROLE_USER` entities with JPA integration.
+- **Optional Frontend:** Generate a pure `REST API` or a complete `Fullstack` application (including login, register, profile, and an admin dashboard).
+- **Entity Generator:** Scaffold JPA Entities, Repositories, Services, DTOs, and REST Controllers instantly from the command line.
+- **Ready-to-use Modules:** Instantly toggle Swagger UI, Spring Mail, and robust Logback configurations logging.
 
-Install globally using npm:
+## 🚀 Installation
+
+Install Sprygen globally via npm to use the `sprygen` command from anywhere:
 
 ```bash
 npm install -g sprygen
 ```
 
-*(For local development, clone the repository, run `npm install`, then `npm run build`, and `npm link`)*
+*(For local development: clone this repository, run `npm install`, `npm run build`, and `npm link`)*
 
-## Commands
+## 🛠️ CLI Commands
 
-### `sprygen new <project-name>`
+### 1. Create a New Project
 
-Launches an interactive prompt to scaffold a new project.
+Launch the interactive prompt to configure and scaffold a new Spring Boot application.
 
 ```bash
-sprygen new my-awesome-api
+sprygen new <project-name>
 ```
 
-It will prompt you for:
-- Package name (e.g. `com.example.app`)
-- Description
-- Build Tool (Maven/Gradle)
-- Database (H2/MySQL/PostgreSQL)
-- Java Version (21/17)
-- Optional Modules (Swagger, Mail, Logging)
+**You will be asked to configure:**
+- Package name (e.g., `com.example.app`)
+- Build Tool (Maven or Gradle)
+- Database (H2, MySQL, PostgreSQL)
+- Auth Strategy (JWT or Session)
+- Project Type (REST API or Fullstack with UI)
+- Optional Modules (Swagger/OpenAPI, Mail, Logging)
 
-### `sprygen add-entity <entity-name>`
+### 2. Generate a New Entity
 
-Must be run inside the generated project's root folder. It prompts you to define fields (types and nullability) for your entity and automatically generates:
-- JPA Entity class
-- Spring Data JpaRepository
-- Service class
-- REST Controller with standard CRUD endpoints
-- DTO class
-- Controller integration test stub
+Run this command **inside** your generated Sprygen project directory. It prompts you to define fields and automatically generates the entire persistence and REST API stack.
 
 ```bash
-cd my-awesome-api
-sprygen add-entity Product
+sprygen add-entity <entity-name>
+# Example: sprygen add-entity Product
 ```
 
-### `sprygen generate-auth`
+**Generated files include:**
+- JPA Entity Class (with fields defined via prompt)
+- Spring Data `JpaRepository`
+- Service Class
+- REST Controller (Standard CRUD endpoints)
+- DTO (Data Transfer Object)
+- Base Integration Test logic
+
+### 3. Inject Authentication
 
-Scaffolds JWT authentication and Spring Security configuration. Useful if you want to add Sprygen's security setup to an existing project not scaffolded by `sprygen new`.
+Useful for modifying existing projects. Scaffolds Sprygen's robust JWT authentication layer and Spring Security configurations into an already existing Spring Boot codebase.
 
 ```bash
 sprygen generate-auth
 ```
 
-## Development
+## 🏗️ Project Architecture
 
-```bash
-# Install dependencies
-npm install
+Applications generated by Sprygen follow standard Spring Boot best practices:
 
-# Run the CLI in development mode using ts-node
-npm run dev new test-project
-
-# Build the project (compiles TypeScript to dist/)
-npm run build
-```
+- **`/config`**: Security configuration, CORS, and module-specific configs.
+- **`/controller`**: REST APIs and MVC routing.
+- **`/dto`**: Data transfer objects (Requests/Responses).
+- **`/entity`**: JPA Data models.
+- **`/repository`**: Spring Data interfaces.
+- **`/security`**: Stateless JWT filters or session logic.
+- **`/service`**: Business logic.
+- **`resources/static`**: Pre-built vanilla JS/CSS/HTML frontend (if Fullstack + JWT is chosen).
 
-## License
+## 📄 License
 
-MIT
+Sprygen is licensed under the MIT License.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "sprygen",
-  "version": "1.0.0",
-  "description": "A JHipster-like Spring Boot project generator CLI written in TypeScript",
+  "version": "1.0.3",
+  "description": "A production-ready Spring Boot project generator CLI. Scaffold secure, structured Java applications with built-in JWT or session authentication, role-based access control, user management, and an optional fullstack frontend — all from a single interactive command.",
   "main": "dist/cli.js",
   "bin": {
     "sprygen": "./dist/cli.js"
@@ -40,14 +40,25 @@
     "spring-boot",
     "generator",
     "scaffold",
-    "jhipster",
+    "cli",
     "java",
     "jwt",
-    "cli"
+    "authentication",
+    "spring-security",
+    "fullstack",
+    "starter-kit"
   ],
   "author": "Sprygen",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wadecalvin9/Sprygen.git"
+  },
+  "bugs": {
+    "url": "https://github.com/wadecalvin9/Sprygen/issues"
+  },
+  "homepage": "https://github.com/wadecalvin9/Sprygen#readme",
   "engines": {
     "node": ">=18.0.0"
   }
-}
+}

package/templates/project/thymeleaf/admin/users.html.ejs

@@ -108,4 +108,4 @@
 </div>
 </body>
 </html>
-
+

package/templates/project/thymeleaf/dashboard.html.ejs

@@ -106,4 +106,4 @@
 </div>
 </body>
 </html>
-
+

package/templates/project/thymeleaf/layout.html.ejs

@@ -72,4 +72,4 @@
 
 </body>
 </html>
-
+

package/templates/project/thymeleaf/login.html.ejs

@@ -53,4 +53,4 @@
 </div>
 </body>
 </html>
-
+

package/templates/project/thymeleaf/profile.html.ejs

@@ -130,4 +130,4 @@
 </div>
 </body>
 </html>
-
+

package/templates/project/thymeleaf/register.html.ejs

@@ -53,4 +53,4 @@
 </div>
 </body>
 </html>
-
+