README.md

Dive into ILLA Builder

Wanna modify illa-builder by yourself? Check out this repo!

🚀Get Started

illa-builder consists of these parts, which are:

• illa-builder (the whole frontend project)
• illa-builder-backend (for managing apps , resources, and actions)
• illa-builder-backend-ws (for managing WebSocket connection)
• illa-supervisor-backend (for managing user info and ABAC)
• illa-supervisor-backend-internal (for illa-builder-backend fetch info which in illa-supervisor-backend)

And the add-ons include:

• nginx (for serving the illa-builder)
• envoy (as all units ingress)
• minio (storage user avatar etc)
• redis (for cache and user session storage)
• postgres (for all data storage)

✨ Index

• Get Started with

  • illa-builder Frontend Code Contributions Guidelines
  • illa-builder Frontend Contributor Covenant Code of Conduct
  • illa-builder-backend Code Contributions Guidelines

• The Design Documents List

  • illa-builder architecture diagram
  • illa-builder-backend Design Documents
  • illa-cli Design Documents

• The API Documents List

  • illa-builder-backend API Server Setup
  • illa-builder-backend HTTP API Documents
  • illa-builder-backend WebSocket Message Documents
  • illa-supervisor-backend HTTP API Documents

• The Database Schema Design and DDLs

  • illa-builder-backend Database Design
  • illa-supervisor-backend Database Design

• The Docker Image Building & Build Locally Documents List

  • build-all-in-one-image (build your own illa-builder image by type make build)
  • deploy-illa-manually (deploy on local machine, docker, docker-compose, k8s)

License

This project is Apache License 2.0.