Suggested Repository Layout

When you develop a software using MIB, we suggest you use the folder structure presented on this wiki page to reduce the need for configuration and make pushing and pulling as easy as possible for your developers.

Let your repository look like this

domaincode folder

In this folder you should put all your domain code. So it will contain mainly microservices and utils projects.

MBI folder

This folder is the complete MIB repository. You should add it as a submodule to your repository.

Why this repo structure?

With this structure you have the benefit of keeping everything related to your project in one place and at the same time separate MIB completely from your domain code.

Furthermore this makes things easy for your developers in 90% of the cases, because as long as they write domain code, the only need to push and pull the complete repository. Only when someone makes changes to MIB, the MIB submodule should be pushed first and afterwards the domain repository should be pushed as well, so that the usage of the new MIB version is available on the master as well.

Don't put your microservices on the same folder level as MIB. The reason for that is, that MIB needs a directory which it scans for microservices (more on that on the [MIB gradle tasks] (MIB gradle tasks) wiki page. If you would have your microservices on the same level as MIB, MIB would find itself as a microservice during scanning.