Contract-Model-Model-View (CMMV)
Building scalable and modular applications using contracts.

Documentation • Report Issue

Description

This project is compile source documentation in markdown format into the published format. The Repository contains cmmv.io source code, the official CMMV documentation.

Installing

Install project dependencies and start a local server with the following terminal commands:

$ pnpm install
$ pnpm run dev

Navigate to http://localhost:3000/.

All pages are written in markdown and located in the docs directory.

Build

Use pnpm run build for a production build.

Submodule Setup

The translations are stored in submodules. To initialize and update them, use the following command:

git submodule update --init --recursive

To push updates for submodules after making commits within the main project, use the following command to ensure the submodules are updated to their remote repositories:

git submodule foreach git push origin main

This command will execute git push origin main for each configured submodule in the project. Make sure you have committed the necessary changes inside the submodules before running this command.

If you want to pull the latest updates for submodules and synchronize them with the main repository, use:

git submodule foreach git pull origin main

Start Processes

After initializing the submodules, start the PM2 processes using the appropriate ecosystem file for each language. Below is an example configuration for PM2:

module.exports = {
    apps: [
        {
            name: "docs-ptbr",
            script: "pnpm run start",
            env: {
                DOCS_LANG: "ptbr",
                PORT: 3001
            }
        }
    ]
};

Start the PM2 process with the following command:

pm2 start ecosystem-ptbr.config.js

NGINX

The system is configured to handle languages using the DOCS_LANG environment variable. Each documentation process runs on an individual port and can be routed via subdomains using a load balancer like NGINX. Below is an example configuration:

server {
    listen 80 default_server;
    server_name _;

    location / {
        proxy_buffering off;
        proxy_set_header Connection "";
        proxy_http_version 1.1;
        proxy_set_header Keep-Alive "";
        proxy_set_header Proxy-Connection "keep-alive";
        proxy_pass http://127.0.0.1:3000;
    }
}

server {
    listen 80;
    server_name pt.cmmv.io;

    location / {
        proxy_buffering off;
        proxy_set_header Connection "";
        proxy_http_version 1.1;
        proxy_set_header Keep-Alive "";
        proxy_set_header Proxy-Connection "keep-alive";
        proxy_pass http://127.0.0.1:3001;
    }
}

Kubernetes

Create a deployment and service for the English version:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: docs-en
  labels:
    app: docs
    lang: en
spec:
  replicas: 2
  selector:
    matchLabels:
      app: docs
      lang: en
  template:
    metadata:
      labels:
        app: docs
        lang: en
    spec:
      containers:
        - name: docs-en
          image: your-docker-image:latest
          ports:
            - containerPort: 3000
          env:
            - name: DOCS_LANG
              value: "en"
            - name: PORT
              value: "3000"
---
apiVersion: v1
kind: Service
metadata:
  name: docs-en
spec:
  selector:
    app: docs
    lang: en
  ports:
    - protocol: TCP
      port: 80
      targetPort: 3000
  type: ClusterIP

Create a deployment and service for the Portuguese version:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: docs-ptbr
  labels:
    app: docs
    lang: ptbr
spec:
  replicas: 2
  selector:
    matchLabels:
      app: docs
      lang: ptbr
  template:
    metadata:
      labels:
        app: docs
        lang: ptbr
    spec:
      containers:
        - name: docs-ptbr
          image: your-docker-image:latest
          ports:
            - containerPort: 3001
          env:
            - name: DOCS_LANG
              value: "ptbr"
            - name: PORT
              value: "3001"
---
apiVersion: v1
kind: Service
metadata:
  name: docs-ptbr
spec:
  selector:
    app: docs
    lang: ptbr
  ports:
    - protocol: TCP
      port: 80
      targetPort: 3001
  type: ClusterIP

With this setup, the English documentation will be available at http://cmmv.io and the Portuguese documentation at http://pt.cmmv.io.