github.com/codefly-dev/core@v0.1.107/resources/templates/workspace/flat/README.md.tmpl (about)

     1  # Welcome to Project {{.Name}}!
     2  
     3  ## What is a project?
     4  
     5  A project is meant to be represent a monorepo of applications that are related to each other.
     6  
     7  See [Documentation](https://docs.codefly.dev/concepts/project/) for more information.
     8  
     9  ## Structure of the project
    10  
    11  A project is structured as follows:
    12  ```shell
    13  .
    14  ├── applications
    15  │   └── foo
    16  │       └── services
    17  │           └── api
    18  │           └── storage
    19  │       └── ...
    20  │   └── bar
    21  │       └── services
    22  │           └── web
    23  │           └── auth
    24  ├── configurations
    25  │   └── ...
    26  ├── deployments
    27  │   └── ....
    28  ```
    29  where `foo` and `bar` are applications of the project.
    30  
    31  `configurations` contains the shared configurations of the project.
    32  
    33  `deployments` contains the deployment manifests of the project for self-managed deployments.