Awesome
Project Manager - Domain-Driven Design workshop application
Project Manager is a sample REST service implemented using Domain-Driven Design technique. Its primary goal is to help me to conduct a Domain-Driven Design workshops. During the workshop developers implement the application on their own, following the steps in right order.
:bulb:
Currently I organize the source code someway different. See the hexagonal_architecture and/or hexagonal_architecture_unit_of_work and/or denormalized_model and/or api_implementation_achitecture branch and also my blog post for more details. Neverless the following workshop is still a valueable way to get familiar with DDD.
Application summary
The Project Manager is a simple application for managing business projects at IT company. The application is directed to project managers. Using the application they can add projects, monitor their progress and assign teams to work on the projects.
Working with application
To run the application execute:
./gradlew bootRun
To run tests execute:
./gradlew test
Steps to implement
Each branch of the repository represents a subsequent step of the overall task. The task is to implement each step using Domain-Driven Design rules, so the unit tests can successfully pass. Checkout the master branch. Get known with the starting code, it contains the parts that are not focused on Domain-Driven Design modelling but are necessary for application to work properly.
The following describes steps to implement using an ubiquitous language. The description contains hints on how to design a model from the business requirements. A hint is a bold part of the text with a suggestion on what domain building block or block part should be used:
- (E) - entity
- (EP) - entity property
- (VO) - value object
- (VOP) - value object property
- (DS) - domain service
- (?) - try to guess :-)
The layers package contains examples on how to properly implement and organize Domain-Driven Design building blocks and other component types.
Step 1 - Create a team
The user can create a new team<sub>(E)</sub>. Every team must be named<sub>(EP)</sub>. To manage teams more efficient the user will need an information on how busy a team currently is. To fulfil this requirement the application must display how many projects a team is currently implementing<sub>(EP)</sub>. A team cannot be created if it already exists.
To do
Checkout the step-1-start branch.
Implement the TeamController.createTeam(...) method, so the unit tests can successfully pass.
Compare your solution with the step-1-finish branch.
Step 2 - Add a member to a team
The user can add a member to a team. Every team consists of members<sub>(EP)</sub> that are company's employees<sub>(VO)</sub>. It is important for an employee that, besides of having a first<sub>(VOP)</sub> and last name<sub>(VOP)</sub>, he has a known job position<sub>(VOP)</sub>. Job position can be one of: developer, scrum master or product owner.
To do
Checkout the step-2-start branch.
Implement the TeamController.addMemberToTeam(...) method, so the unit tests can successfully pass.
Compare your solution with the step-2-finish branch.
Step 3 - Show teams
The user can browse teams. He can see their members and on how many projects teams are working right now. If a team is working on more than 3 projects the user sees it as a busy team.
To do
Checkout the step-3-start branch.
Implement the TeamController.getTeams(...) method, so the unit tests can successfully pass.
Compare your solution with the step-3-finish branch.
Step 4 - Create a project draft
The user can create project<sub>(E)</sub> drafts. A project draft includes minimum information about the project. It requires a project name<sub>(EP)</sub> and an automatically generated unique project identifier<sub>(DS)</sub>. A newly created project has a "to do" status<sub>(EP)</sub>. No team<sub>(EP)</sub> is assigned to work on a newly created project.
To do
Checkout the step-4-start branch.
Implement the ProjectController.createProject(...) method, so the unit tests can successfully pass.
Compare your solution with the step-4-finish branch.
Step 5 - Create a full project
The user can also create a full project. A full project is a project draft with extra information. It must contain a list of features<sub>(EP)</sub> that are required to implement within the project. Every feature<sub>(VO)</sub> has to be named<sub>(VOP)</sub> and it must have status<sub>(VOP)</sub> and requirement<sub>(VOP)</sub> defined. For the newly created feature a "to do" status has to be set. Requirement can be one of: optional, recommended or necessary.
To do
Checkout the step-5-start branch.
Implement the ProjectController.createProject(...) method, so the unit tests can successfully pass.
Compare your solution with the step-5-finish branch.
Step 6 - Show projects
The user can browse projects. He can see their list. Every item on the list contains a project identifier and name.
To do
Checkout the step-6-start branch.
Implement the ProjectController.getProjects(...) method, so the unit tests can successfully pass.
Compare your solution with the step-6-finish branch.
Step 7 - Show a specific project
The user can also browse a specific project when he clicks on it in the projects list. He can see all information about the clicked project.
To do
Checkout the step-7-start branch.
Implement the ProjectController.getProject(...) method, so the unit tests can successfully pass.
Compare your solution with the step-7-finish branch.
Step 8 - Edit a project
The user can edit created projects. He can update its name, features and he can assign a team<sub>(DS)</sub> to work on a project. Feature status can be change to one of: to do, in progress or done. If a team is assigned to a project then the project counts as a project implemented by the team.
To do
Checkout the step-8-start branch.
Implement the ProjectController.updateProject(...) method, so the unit tests can successfully pass.
Compare your solution with the step-8-finish branch.
Step 9 - Start a project
The user can start a project only if the project is assigned to a team. When the project starts its status is changed to "in progress".
To do
Checkout the step-9-start branch.
Implement the ProjectController.startProject(...) method, so the unit tests can successfully pass.
Compare your solution with the step-9-finish branch.
Step 10 - End a project
The user can end a started project when all of the features in the project are done<sub>(?)</sub>. Sometimes the users supervisor can give him a permission to end a project when only the necessary features are done<sub>(?)</sub>. Ended projects don't count as projects implemented by a team. Ended projects needs to be reported in the company's end year review. To do that the application needs to inform a Reporting Service about the ended project<sub>(?)</sub> by sending its identifier<sub>(?)</sub>.
To do
Checkout the step-10-start branch.
Implement the ProjectController.endProject(...) method, so the unit tests can successfully pass.
Compare your solution with the step-10-finish branch.
Hexagonal architecture
Following the workshop's steps creates an application designed in classic layered architecture. The hexagonal_architecture branch shows the fully implemented application in hexagonal architecture.