Start modelling your app today.

Get started for free

What's this?

File Structure

An outline of the file structure which is used in bot-written applications.


While many files are controlled by the contents of the What is an entity diagram?, The User Interface Diagram and Using the Security Diagram diagrams, there exists a base high-level file structure that remains consistent for all apps.

This file structure is consistent across both C#Bot and SpringBot.

Structure

graph TD
    bd(App Root Directory) --> clientside
    bd --> serverside
    bd --> models
    bd --> testtarget
Directory Description
clientside Contains the client-side source code for the application (i.e the Angular or React components)
serverside The server-side source code for the application. This contains the C# or Java components.
models The serialised diagrams which were built on the platform. See below for more information.
testtarget The integration tests for the application, written separately and based on the technologies used by the respective bots.

The models folder

While the other directories are relatively self explanatory and can be found in many other projects external to Codebots, the models directory is special.

One of the key benefits of Codebots is that the platform does not follow a lock-in business model. Keeping with this, the key artefacts that are created on the platform, (the UI, Entity and Security diagrams) are serialised and placed within your file structure for external use. These models are serialised into an XML format to allow for ease of use.

The models directory follows the following structure:

graph TD
    models --> entity
    models --> security
    models --> ui
Directory Description
entity The model for the entity diagram.
security The model for the security diagram.
ui The model for the user interface diagram.

Last updated: 24 July 2020


Start modelling your app today.