-
Notifications
You must be signed in to change notification settings - Fork 9
Repository Structure
The repository's root contains generic files such as the README, LICENSE and .gitignore.
The actual SDK can be found in the ./src folder, while the ./sandbox folder contains an ASP.NET Core project that demonstrates the functionality of the SDK.
The ./src folder contains the SDK Visual Studio solution. Each project in the solution is located in a separate folder (e.g. ./src/TheNeBoston contains the SDK class library, ./src/TheNewBoston.Tests contains the unit tests for the SDK).
The SDK project (./src/TheNewBoston) is divided based on entities, such as Bank, Account, Transaction, etc. Furthermore, each entity folder is divided by layers: Models, DataAccess, API, etc.
The unit test project should follow the SDK folder structure when it comes to the classes it tests. For example, the tests for the Bank API will be located in ./src/TheNewBoston.Tests/Bank/API.
The ./sandbox folder contains the ASP.NET Core sandbox solution. Similar to the SDK project, each project in the solution is located in its specific folder.
For the ASP.NET Core project, the division will be made the same as for the SDK project: first by entity, then by layer. For example, there will be a ./sandbox/TheNewBostonSandbox/Bank folder, which furthermore contains a Controllers folder, a Models folder, etc.
The unit test project should follow the sandbox folder structure when it comes to the classes it tests. For example, the tests for the Bank services will be located in ./src/TheNewBostonSandbox/Bank/Services.