laf/server/README.md

Intro

laf server is responsible for laf http api:

• auth & user
• region cluster
• app management
• app cloud function management
• app database management
• app storage management
• app log management
• app instance management

Development

You should know

• Node.js
• Nest web framework
• Kubernetes basic use
• Telepresence for local development
• MongoDb basic use
• MinIO object storage
• APISIX gateway
• nestjs-i18n i18n

Prerequisites

• laf cluster installed locally or remotely (~/.kube/config)
• telepresence installed (see https://www.telepresence.io/reference/install)
• minio client installed (see https://min.io/download#)

Start service locally

cd server/

# telepresence version v2.16.1
# Install telepresence traffic manager 
telepresence helm install
# Connect your computer to laf-dev cluster (namespace laf-system)
telepresence connect -n laf-system
# Connect local server to laf server cluster (namespace laf-system)
telepresence intercept laf-server  -p 3000:3000 -e $(pwd)/.env

npm install
npm run watch

Clean up

telepresence leave laf-server

Troubleshooting

• telepresence helm install failed for arm64 / Apple Chip cluster, please upgrade your telepresence to v2.11.1 or later.