Skip to content
This repository was archived by the owner on Nov 6, 2023. It is now read-only.

Commit 8461765

Browse files
committed
Improve ReadMe specifying the project purpose
1 parent 92a3263 commit 8461765

File tree

1 file changed

+30
-7
lines changed

1 file changed

+30
-7
lines changed

README.md

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,35 @@
1-
# Java Bootstrap (base / project skeleton)
1+
# ☕🎯 Hexagonal Architecture + DDD + CQRS Java example with SpringBoot
22

3-
## Introduction
3+
<img src="http://codely.tv/wp-content/uploads/2016/05/cropped-logo-codelyTV.png" align="left" width="192px" height="192px"/>
4+
<img align="left" width="0" height="192px" hspace="10"/>
45

5-
This is a repository intended to serve as a starting point if you want to bootstrap a project in Java 8 with JUnit 5.2 and Gradle 4.6.
6+
> You can do awesome stuff with Java 🙂
67
7-
## How To Start
8+
[![CodelyTV](https://img.shields.io/badge/codely-tv-green.svg?style=flat-square)](https://codely.tv)
9+
[![Build Status](https://travis-ci.com/CodelyTV/cqrs-ddd-java-example.svg?branch=master)](https://travis-ci.com/CodelyTV/cqrs-ddd-java-example)
810

9-
1. Install Java 8
10-
2. Clone this repository `git clone https://github.com/CodelyTV/java-bootstrap`.
11-
3. Run the tests with `./gradlew test`
11+
Implementation example of a Java application following Domain-Driven Design (DDD) and Command Query Responsibility Segregation (CQRS) principles, keeping the code as simple as possible.
12+
13+
Take a look, play and have fun with it!
14+
15+
## 🚀 Environment setup
16+
17+
1. Install Java: `brew cask install java`
18+
2. Clone this repository: `git clone https://github.com/CodelyTV/java-bootstrap`.
19+
3. Execute some [Gradle lifecycle tasks](https://docs.gradle.org/current/userguide/java_plugin.html#lifecycle_tasks) in order to check everything is OK:
20+
1. Create [the project JAR](https://docs.gradle.org/current/userguide/java_plugin.html#sec:jar) and other project artifacts:
21+
`./gradlew assemble --warning-mode all`
22+
2. Run the tests and plugins verification tasks:
23+
`./gradlew check --warning-mode all`
1224
4. Start developing!
25+
26+
## 🤔 How to update dependencies
27+
28+
* Gradle (current version: 5.1.1 - [releases](https://gradle.org/releases/)):
29+
`./gradlew wrapper --gradle-version=5.1.1 --distribution-type=bin` or modifying the [gradle-wrapper.properties](gradle/wrapper/gradle-wrapper.properties#L3)
30+
* JUnit (current version: 5.3.2 - [releases](https://junit.org/junit5/docs/snapshot/release-notes/index.html)):
31+
[`build.gradle:11`](build.gradle#L11-L12)
32+
33+
## 🤝 Contributing
34+
35+
There are a lot of missing things (add swagger/OpenAPI, improve documentation...), feel free to add them if you want!

0 commit comments

Comments
 (0)