generator-nokode


A Yeoman generator for creating Spring Boot applications with the Nokode framework. This generator scaffolds a complete Spring Boot application with authentication, user management, role-based access control, and MongoDB integration.

Features

- 🚀 Spring Boot 3.5.5 with Java 17
- 🔐 Authentication & Authorization with role-based access control
- 👥 User Management with CRUD operations
- 🗄️ MongoDB Integration with Spring Data
- 📝 OpenAPI Documentation with Swagger UI
- 🛠️ MapStruct for object mapping
- 🔒 Security with interceptors and CORS configuration
- 📊 Auditing and logging capabilities
- 🧪 Testing setup with JUnit

Prerequisites

- Node.js (>= 14.0.0)
- Java 17
- Gradle
- MongoDB

Installation

First, install Yeoman and generator-nokode using npm (we assume you have pre-installed node.js).

``bash
npm install -g yo
npm install -g generator-nokode
`

Usage

$3

Run the generator in interactive mode:

`bash
yo nokode
`

The generator will prompt you for:

- Application name
- Group ID (e.g., com.example)
- Java package name (e.g., com.example.myapp)
- System email address

$3

You can also provide all parameters via command line:

`bash
yo nokode --appName="MyApp" --groupId="com.example" --packageName="com.example.myapp" --systemEmailAddress="admin@example.com"
`

Generated Project Structure

`
my-app/
├── src/
│ ├── main/
│ │ ├── java/
│ │ │ └── com/example/myapp/
│ │ │ ├── MyAppApplication.java
│ │ │ ├── config/
│ │ │ │ ├── AuthConfig.java
│ │ │ │ ├── MongoConfig.java
│ │ │ │ ├── WebConfig.java
│ │ │ │ └── ...
│ │ │ ├── user/
│ │ │ │ ├── domain/
│ │ │ │ ├── dto/
│ │ │ │ ├── mapper/
│ │ │ │ ├── repository/
│ │ │ │ └── service/
│ │ │ └── role/
│ │ │ ├── domain/
│ │ │ ├── dto/
│ │ │ ├── mapper/
│ │ │ ├── repository/
│ │ │ └── service/
│ │ └── resources/
│ │ └── application.properties
│ └── test/
│ └── java/
│ └── com/example/myapp/
│ └── MyAppApplicationTests.java
├── build.gradle
├── settings.gradle
└── gradlew
`

Configuration

After generation, update the application.properties file with your specific configuration:

`properties


Database Configuration

spring.data.mongodb.uri=mongodb://localhost:27017/myapp

Server Configuration

server.port=8080

Security Configuration

app.security.jwt.secret=your-jwt-secret-key
app.security.jwt.expiration=86400000

Email Configuration

app.email.host=smtp.gmail.com
app.email.port=587
app.email.username=your-email@gmail.com
app.email.password=your-app-password
`

Running the Application

1. Start MongoDB:

`bash
mongod
`

2. Run the application:

`bash
./gradlew bootRun
`

3. Access the application:

- API: http://localhost:8080
- Swagger UI: http://localhost:8080/swagger-ui.html

API Endpoints

The generated application includes the following endpoints:

$3

- POST /api/users - Create user
- GET /api/users - Get all users
- GET /api/users/{id} - Get user by ID
- PUT /api/users/{id} - Update user
- DELETE /api/users/{id} - Delete user

$3

- POST /api/roles - Create role
- GET /api/roles - Get all roles
- GET /api/roles/{id} - Get role by ID
- PUT /api/roles/{id} - Update role
- DELETE /api/roles/{id} - Delete role

$3

- POST /api/auth/login - User login
- POST /api/auth/signup - User signup
- POST /api/auth/reset-password - Reset password

Development

$3

`bash
./gradlew test
`

$3

`bash
./gradlew build
`

$3

`bash
docker-compose up
`

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature`)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you have any questions or need help, please:

1. Check the Issues page
2. Create a new issue if your problem isn't already reported
3. Contact the maintainers at info@thepanther.io

Changelog

$3

- Initial release
- Spring Boot 3.5.5 support
- User and Role management
- MongoDB integration
- Authentication and authorization
- OpenAPI documentation