CX Cloud Docs
Primary version
Primary version
  • Welcome To CX Cloud
  • Introduction
    • Why CX Cloud?
    • Architecture Overview
    • How To Participate?
    • Change Log
  • Getting Started
    • Requirements
      • Prepare Local Environment
      • Install CX Cloud CLI
    • Setting up a CX Cloud Project
      • Provision Infrastructure
      • Generating Core Services
      • Generating a Frontend Demo
      • Configuring Routing Manifest
      • Configuring CI/CD Pipeline
      • Configuring Data Engine
  • Guides
    • Infrastructure Operations
      • Getting Access To An Already Running Infrastructure
      • Deleting Deployments
      • Managing Secrets
    • Application Development
      • Git Repository Conventions
      • Process Engine
Powered by GitBook
On this page
  1. Guides
  2. Application Development

Git Repository Conventions

The development strategy required to use a "monorepo" in order to deploy all services using CI/CD pipeline. The repository contains multiple packages (microservices) that can but do not have to be related.

Project structure

The file structure for the monorepo should look like:

my-monorepo
├── packages
|   ├── package 1
|   |   ├── .cxcloud.yaml
|   |   └── ...
|   ├── package 2
|   |   ├── .cxcloud.yaml
|   |   └── ...
|   └── package n
|       ├── .cxcloud.yaml
|       └── ...
├── .cxcloud.yaml
└── ...

Every microservice folder should include .cxcloud.yaml file with the configuration for Kubernetes.

There is no naming convention for the packages, but it is recommended to add a prefix to the microservice such as "package-" or "service-".

PreviousApplication DevelopmentNextProcess Engine

Last updated 5 years ago

In order to simplify and optimize the workflow around development with the multi-package repository, the managing tool such as can be in use.

Lerna