Skip to content

Folder structure

Kpaubert edited this page Feb 20, 2021 · 6 revisions

Folder structure

Here you will find documentation on how to navigate through the source code.

Existing folder structure

As of now, the solution only contains two actual folders, namely for the API and the tests. Regarding best practices, it is standard to use the MVC-pattern for ASP.NET applications, but that will not be the case for us, as the frontend is written using React.js. The current project setup looks like this (from root):

  • Config and startup files
    • C# launch files, appsettings, readme, Dockerfile, etc.
  • API
    • Includes queries, schemas and services
  • Mocks
    • Is used for containing objects that mimic the models and create mocking data to the POCO's
  • Models
    • POCO's for the DTO's
  • utils
    • Should be used mainly for static classes for easy access. An example would be for fetching a variable with a certain folder path

Some directories that we might need in the future include:

  • Middleware
  • Exceptions
  • Persistence

Further documentation on these points will come on the near future.