{"id":27217443,"url":"https://github.com/luismr/spring-commander","last_synced_at":"2025-04-10T05:28:41.717Z","repository":{"id":287018601,"uuid":"963307476","full_name":"luismr/spring-commander","owner":"luismr","description":"Spring Commander is a lightweight framework for implementing the Command-Query Separation (CQS) pattern in Java Spring Boot, powered by a clean Mediator architecture.","archived":false,"fork":false,"pushed_at":"2025-04-09T15:28:04.000Z","size":24,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-09T15:31:48.434Z","etag":null,"topics":["clean-architecture","cqs","framework","java","java-21","mediator","spring-autoconfiguration","spring-boot"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/luismr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-04-09T13:32:25.000Z","updated_at":"2025-04-09T15:28:08.000Z","dependencies_parsed_at":"2025-04-09T15:33:42.272Z","dependency_job_id":"f200b0cd-d5db-41f4-aa8a-b65b3de6f83f","html_url":"https://github.com/luismr/spring-commander","commit_stats":null,"previous_names":["luismr/spring-commander"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luismr%2Fspring-commander","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luismr%2Fspring-commander/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luismr%2Fspring-commander/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luismr%2Fspring-commander/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luismr","download_url":"https://codeload.github.com/luismr/spring-commander/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248162620,"owners_count":21057788,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clean-architecture","cqs","framework","java","java-21","mediator","spring-autoconfiguration","spring-boot"],"created_at":"2025-04-10T05:28:41.259Z","updated_at":"2025-04-10T05:28:41.704Z","avatar_url":"https://github.com/luismr.png","language":"Java","readme":"# Spring Commander 🍮\n\n![Java](https://img.shields.io/badge/Java-21-blue)\n![SpringBoot](https://img.shields.io/badge/SpringBoot-3.4.x-blue)\n![JUnit](https://img.shields.io/badge/JUnit-5.x-blue)\n![JaCoCo](https://img.shields.io/badge/JaCoCo-0.8.x-blue)\n\nSpring Commander is a lightweight framework for implementing the Command-Query Separation (CQS) pattern in Java Spring Boot, powered by a clean Mediator architecture.\n\n## Features\n\n- Command-Query Separation (CQS) pattern implementation\n- Clean Mediator architecture\n- Spring Boot auto-configuration\n- Type-safe command and query handling\n- Easy integration with Spring Boot applications\n- Comprehensive test coverage\n- GitHub Actions CI/CD pipeline\n\n## Build Status\n\n[![Java CI with Maven](https://github.com/luismr/spring-commander/actions/workflows/maven.yml/badge.svg)](https://github.com/luismr/spring-commander/actions/workflows/maven.yml)\n![Coverage](badges/jacoco.svg)\n![Branches](badges/branches.svg)\n\n## GitHub Actions Setup\n\nTo enable automatic updates of code coverage badges, you need to configure GitHub Actions permissions:\n\n1. Go to your repository settings\n2. Navigate to \"Actions\" → \"General\"\n3. Under \"Workflow permissions\", select:\n   - \"Read and write permissions\"\n   - Check \"Allow GitHub Actions to create and approve pull requests\"\n4. Save the changes\n\nThis will allow the GitHub Actions workflow to:\n- Update code coverage badges\n- Commit changes to the repository\n- Create and update pull requests\n\n## Getting Started\n\n### Prerequisites\n\n- Java 21\n- Maven 3.6+\n- Spring Boot 3.4.4+\n\n### Installation\n\n#### Using Git\n\n```bash\ngit clone git@github.com:luismr/spring-commander.git\n```\n\n#### Using Maven\n\n1. First, configure your GitHub token in `~/.m2/settings.xml`:\n\n```xml\n\u003csettings\u003e\n  \u003cservers\u003e\n    \u003cserver\u003e\n      \u003cid\u003egithub\u003c/id\u003e\n      \u003cusername\u003eYOUR_GITHUB_USERNAME\u003c/username\u003e\n      \u003cpassword\u003eYOUR_GITHUB_TOKEN\u003c/password\u003e\n    \u003c/server\u003e\n  \u003c/servers\u003e\n\u003c/settings\u003e\n```\n\n\u003e **Note:** If you don't have a GitHub token, you can request one by contacting me on [X (@luismachadoreis)](https://x.com/luismachadoreis) or [BlueSky (@luismachadoreis.bsky.social)](https://bsky.app/profile/luismachadoreis.bsky.social).\n\n2. Add the GitHub Packages repository to your `pom.xml`:\n\n```xml\n\u003crepositories\u003e\n    \u003crepository\u003e\n        \u003cid\u003egithub\u003c/id\u003e\n        \u003cname\u003eSpring Commander GitHub Packages\u003c/name\u003e\n        \u003curl\u003ehttps://maven.pkg.github.com/luismr/spring-commander\u003c/url\u003e\n    \u003c/repository\u003e\n\u003c/repositories\u003e\n```\n\n3. Add the dependency to your `pom.xml`:\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003edev.luismachadoreis.blueprint\u003c/groupId\u003e\n    \u003cartifactId\u003espring-commander\u003c/artifactId\u003e\n    \u003cversion\u003e0.0.3\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### Gradle\n\n1. First, configure your GitHub token in `~/.gradle/gradle.properties`:\n\n```properties\ngpr.user=YOUR_GITHUB_USERNAME\ngpr.key=YOUR_GITHUB_TOKEN\n```\n\n2. Add the GitHub Packages repository to your `build.gradle`:\n\n```groovy\nrepositories {\n    maven {\n        name = \"GitHubPackages\"\n        url = uri(\"https://maven.pkg.github.com/luismr/spring-commander\")\n        credentials {\n            username = project.findProperty(\"gpr.user\") ?: System.getenv(\"GITHUB_USERNAME\")\n            password = project.findProperty(\"gpr.key\") ?: System.getenv(\"GITHUB_TOKEN\")\n        }\n    }\n}\n```\n\n3. Add the dependency to your `build.gradle`:\n\n```groovy\nimplementation 'dev.luismachadoreis.blueprint:spring-commander:0.0.3'\n```\n\n## Usage\n\n### Commands\n\n1. Create a command:\n\n```java\npublic class CreateUserCommand implements Command\u003cUser\u003e {\n    private final String username;\n    private final String email;\n\n    public CreateUserCommand(String username, String email) {\n        this.username = username;\n        this.email = email;\n    }\n\n    // Getters\n}\n```\n\n2. Create a command handler:\n\n```java\n@Component\npublic class CreateUserCommandHandler implements CommandHandler\u003cCreateUserCommand, User\u003e {\n    @Override\n    public User handle(CreateUserCommand command) {\n        // Implementation\n        return new User(command.getUsername(), command.getEmail());\n    }\n}\n```\n\n3. Use the mediator in your service:\n\n```java\n@Service\npublic class UserService {\n    private final SpringCommanderMediator mediator;\n\n    public UserService(SpringCommanderMediator mediator) {\n        this.mediator = mediator;\n    }\n\n    public User createUser(String username, String email) {\n        return mediator.send(new CreateUserCommand(username, email));\n    }\n}\n```\n\n### Queries\n\n1. Create a query:\n\n```java\npublic class GetUserQuery implements Query\u003cUser\u003e {\n    private String username;\n    \n    // Getters and setters\n}\n```\n\n2. Create a query handler:\n\n```java\n@Component\npublic class GetUserQueryHandler implements QueryHandler\u003cGetUserQuery, User\u003e {\n    @Override\n    public User handle(GetUserQuery query) {\n        // Implementation\n    }\n}\n```\n\n### Using the Mediator\n\n```java\n@Autowired\nprivate SpringMediator mediator;\n\npublic void example() {\n    // Send a command\n    User user = mediator.send(new CreateUserCommand(\"username\", \"email@example.com\"));\n    \n    // Send a query\n    User foundUser = mediator.send(new GetUserQuery(\"username\"));\n}\n```\n\n## Development\n\n### Prerequisites\n\n- Java 21 or later\n- Maven 3.8 or later\n- Git\n\n### Building\n\n```bash\ngit clone https://github.com/luismr/spring-commander-java.git\ncd spring-commander-java\nmvn clean install\n```\n\n### Testing\n\n```bash\nmvn test\n```\n\n### Code Coverage\n\nCode coverage reports are generated automatically during the build process. You can find the reports in the `target/site/jacoco` directory.\n\n## Contributing\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## GitHub Actions\n\nThe project uses GitHub Actions for continuous integration and deployment. The workflow includes:\n\n- Building and testing on multiple Java versions\n- Code coverage reporting\n- Automatic updates of code coverage badges\n- Deployment to GitHub Packages\n\n## Maven Release Process\n\n### Prerequisites\n\n1. Configure GitHub authentication in your Maven settings (`~/.m2/settings.xml`):\n\n```xml\n\u003csettings\u003e\n  \u003cservers\u003e\n    \u003cserver\u003e\n      \u003cid\u003egithub\u003c/id\u003e\n      \u003cusername\u003eYOUR_GITHUB_USERNAME\u003c/username\u003e\n      \u003cpassword\u003eYOUR_GITHUB_TOKEN\u003c/password\u003e\n    \u003c/server\u003e\n  \u003c/servers\u003e\n\u003c/settings\u003e\n```\n\n2. Create a GitHub Personal Access Token (PAT) with the following permissions:\n   - `read:packages`\n   - `write:packages`\n   - `delete:packages`\n\n### Performing a Release\n\n1. Prepare the release:\n```bash\nmvn release:prepare\n```\nThis will:\n- Update version numbers\n- Create a Git tag\n- Update the SCM information\n\n2. Perform the release:\n```bash\nmvn release:perform\n```\nThis will:\n- Checkout the tagged version\n- Build and deploy to GitHub Packages\n- Create source and Javadoc JARs\n\n### Version Management\n\n- SNAPSHOT versions are deployed to GitHub Packages automatically on each push to main\n- Release versions are created manually using the release process\n- Version format follows semantic versioning (MAJOR.MINOR.PATCH)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.\n\n## Author\n\n- **Luis Machado Reis** - [luismr](https://github.com/luismr)\n\n## Acknowledgments\n\n- Spring Boot team for the amazing framework\n- Martin Fowler for the CQS pattern\n- All contributors and users of this project ","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluismr%2Fspring-commander","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluismr%2Fspring-commander","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluismr%2Fspring-commander/lists"}