kushibrahim / taskmanagement Goto Github PK

Readme file must explain project's purpose, and dependencies (such as Java 8+, maven, etc.)

to practise continuous integration, configure a Github action that executes a maven build.
hence this project contains integration tests, and these tests requires an "up and running" database instance, follow the pattern below:

• fork a new branch named "test" from master.

• disable all tests required a database connection with @disabled annotation in this branch.

• configure a GitHub action that executes a maven build, triggered by push to "test" branch.

note: "test" branch will not be merged into master. on the contrary, all commits applied into master must be applied to test branch after this point. (git merge master)

Unit tests must be written for each controller, service and converter. Hence Spring Data is used, and repository layer using default implementations, repository tests are not required.

naming convention for data transfer objects should follow this pattern: "xDto" instead of "xEntityDto"

configure a Dockerfile uses openjdk:8-jdk-alpine, to dockerize this project.

• fork a feature branch named "feature/docker" from master.
  (hint: git checkout -b feature/docker)

• add Dockerfile.

• after that, create a pull request from "feature/docker" to "master".

• link pull request to this issue.

• assign issue to me.

• fork a feature branch named "feature/swagger2" from master.
  (hint: git checkout -b feature/swagger2)

• add swagger2 support, both for api docs and ui.

• after that, create a pull request from "feature/swagger2" to "master".

• link pull request to this issue.

• assign issue to me.

Project could be seamlessly compiled and runned. Unimplemented features (such as getTaskById in TaskController) should not expose compile time errors, at least they must be commented-out.