forked from intelops/compage
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8938096
commit e9e7411
Showing
336 changed files
with
765 additions
and
507 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,9 +8,7 @@ If you find a bug while working with the Compage, please [open an issue on GitHu | |
| You are more than welcome to open issues in this project to [suggest new features](https://github.com/intelops/compage/issues/new?labels=kind%2Ffeature&template=feature-request.md&title=Feature%20Request:). | ||
|
|
||
| ## Contributing Code | ||
| This project is written in Golang, Node.js(TypeScript) and ReactJs(TypeScript). | ||
|
|
||
|  | ||
| This project is written in Golang | ||
|
|
||
| To contribute code. | ||
| 1. Ensure you are running golang version 1.11.4 or greater for go module support | ||
|
|
@@ -19,26 +17,15 @@ To contribute code. | |
| GO111MODULE=on | ||
| GOFLAGS=-mod=vendor | ||
| ``` | ||
| 3. Ensure you have Node.js(LTS >= v18.18.0) installed for app and ui part of the compage. | ||
| #### KinD | ||
| - Install KinD from https://kind.sigs.k8s.io/docs/user/quick-start/#installing-from-release-binaries | ||
| - Create KinD cluster using below command | ||
| ```shell | ||
| cd deploy | ||
| ./create-kind-cluster.sh | ||
| ``` | ||
| - Check if you can access the cluster created in previous step, and you are able to list down the pods. | ||
| 4. Fork the project. | ||
| 5. Clone the project: `git clone https://github.com/[YOUR_USERNAME]/compage && cd compage` | ||
| 6. kindly refer compage.md file to know the structure of the project. | ||
| 7. The Compage has three servers (subprojects) which need to be started to run the compage on local | ||
| - (Golang), navigate to core directory and follow its [core README](./core/README.md) | ||
| 8. Commit changes *([Please refer the commit message conventions](https://www.conventionalcommits.org/en/v1.0.0/))* | ||
| 9. Push commits. | ||
| 10. Open pull request. | ||
| 3. Fork the project. | ||
| 4. Clone the project: `git clone https://github.com/[YOUR_USERNAME]/compage && cd compage` | ||
| 5. kindly refer compage.md file to know the structure of the project. | ||
| 6. Commit changes *([Please refer the commit message conventions](https://www.conventionalcommits.org/en/v1.0.0/))* | ||
| 7. Push commits. | ||
| 8. Open pull request. | ||
| ## Regenerate the gRPC code from .proto files | ||
| - Install below packages in order to regenerate the gRPC code. | ||
| - Install below packages to regenerate the gRPC code. | ||
| ```shell | ||
| go install google.golang.org/protobuf/cmd/[email protected] | ||
| go install google.golang.org/grpc/cmd/[email protected] | ||
|
|
@@ -50,6 +37,4 @@ To contribute code. | |
| - Download buf binary from this link—https://github.com/bufbuild/buf/releases and fire the command from root directory of compage. | ||
| ```shell | ||
| buf generate | ||
| ``` | ||
| ## How are DB(sqlite/cassandra) and GitHub interacted with above three components? | ||
|  | ||
| ``` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| <p align="center"><img src="images/compage-logo.svg" width="400" alt=""></p> | ||
| <p align="center"><b>Low-Code, No-Code for cloud-native</b></p> | ||
|
|
||
| <h4 align="center"> | ||
| <a href="https://discord.gg/DeapQc22qe">Discord</a> | | ||
| <a href="https://github.com/intelops/compage/discussions">Discussions</a> | | ||
| <a href="https://docs.intelops.ai/1.0.0/compage/5-guides?utm_source=github&utm_medium=social/">Guide</a> | | ||
| <a href="https://docs.intelops.ai/1.0.0/compage">Docs</a> | | ||
| <a href="https://docs.intelops.ai/1.0.0/compage/6-contribution?utm_source=github&utm_medium=social">Contribute</a><br/><br/> | ||
| </h4> | ||
|
|
||
| <h4 align="center"> | ||
|
|
||
|  | ||
| [](https://codecov.io/gh/intelops/compage) | ||
| [](https://goreportcard.com/report/github.com/intelops/compage/core) | ||
|
|
||
| [](https://github.com/intelops/compage/blob/main/LICENSE) [](https://discord.gg/DeapQc22qe) | ||
| [](https://github.com/intelops/compage/discussions) | ||
| [](./code-of-conduct.md) | ||
| [](https://opensource.org/licenses/Apache-2.0) | ||
|
|
||
| </h4> | ||
|
|
||
| <hr> | ||
|
|
||
| # Compage by IntelOps | ||
|
|
||
| Low-Code Framework to develop Rest APIs, gRPC, dRPC, GraphQL APIs, WebSockets, Micro-services, FaaS, Temporal workloads, | ||
| IoT and edge services, K8s controllers, K8s CRDs, K8s custom APIs, K8s Operators, K8s hooks, etc. with visual coding and | ||
| by automatically applying best practice methods like software supply chain security measures, SBOM, openAPI, | ||
| cloud-events, vulnerability reports, etc. Auto generate code after defining requirements in UI as architecture diagram. | ||
|
|
||
| **Specify the requirements for backend workloads in the yaml file, and then auto-generate code, customize it and maintain it.** | ||
| > Our goal is to support both auto-generate code and import existing code. Let's see how far we can go with importing | ||
| > existing code support. One step at a time! | ||
| #### Problems that Compage is trying to solve: | ||
|
|
||
| Problems with many of the current low-code platforms - | ||
|
|
||
| - Single programming language support only. | ||
| - Vendor Lock-in Infrastructure if you want to choose their cloud hosting. | ||
| - No proper support or automation for self-hosting and also lots of dependencies on the low-code/no-code tool itself to | ||
| run it on your infrastructure. | ||
| - No Zero-Vendor Lock-in platform to generate cloud-native. friendly backend source code, especially for Rest APIs, | ||
| gRPC, | ||
| WebSockets, etc. in any programming language and framework we want. | ||
| - Non-availability of a very opinionated development process & management of infrastructure. | ||
| - Not compatible to cloud-native, especially for self-hosting K8s environment. | ||
| - Not invoking standards like openAPI, Event-driven, software supply chain security, secure container builds, | ||
| microservices, etc. | ||
| - Not supporting modern tech stack and no feasibility to adopt new tech stack dynamically. | ||
| - No bi-directional code management (export, import and manage). | ||
| - No easy UX to make any level of developer to learn, adopt and implement development process for K8s ecosystem for | ||
| cloud-native world. | ||
| - and the list can go on **(please let us know what more you can think of, we will try to solve those problems for you) | ||
| ** | ||
|
|
||
| Solution: **Compage** | ||
|
|
||
| - An opensource tool that can be run on your local and used to develop backend workloads for cloud-native & K8s :- | ||
| - Easy to adopt & use. | ||
| - GitHub Actions, container build tools, cosign, etc. | ||
| - Select the programming language and framework you prefer (support for each programming language and framework will be | ||
| added one by one); first priority is GoLang and Rust. Frameworks can be configured as plug-ins. | ||
| - Auto generate code for backend workloads like Rest API, gRPC, dRPC, GraphQL, WebSockets, Microservices, FaaS, | ||
| Temporal workloads, IoT and edge services, K8s controllers, K8s CRDs, K8s custom APIs, K8s Operators, K8s hooks, etc. | ||
| **(for now support will be for golang and then Rust as priority, followed by Python, C, Carbon, Node.js, Dart, Deno, | ||
| etc. Community contribution will help us to achieve more support)** | ||
| - Auto-generate the backend code, based on requirements defined via diagram & forms | ||
| - Auto-generate the endpoint configs to be able to use with API gateways & service-mesh environments like Kong, Tyk, | ||
| Easegress, Istio, Linkerd, Kuma, Ngnix, Cilium tools, Calico, etc. | ||
| - Easy plug-ins by supporting tools like Ory Hydra, Kratos, Keto, OathKeeper, KeyCloak, Gluu, Janssen, Cerbos, Open | ||
| Policy Agent, OAuth, OIDC, FIDO, SAML, Dex, MFA, Passwordless, etc. | ||
| - Auto build containers as multi-stage and/or distroless to make them secure, portable and optimal. | ||
| - Automatically take care of all git processes like tagging, versioning, commits, PRs, etc. | ||
| - Automatically enforce software supply chain security process like signing the source code for integrity and generating | ||
| immutable ledger logs, generating SBOM, generating vulnerability report, and also generate configurations to auto | ||
| verify, validate & control the source code integrity and container image integrity for deployments, etc. in K8s env. | ||
| - Automatically convert backend application related environment variables' content to configmaps, secrets, etc. to make | ||
| the generated backend compatible to K8s of any flavor (K8s, K3s, TalOS, etc.) and also auto configs to support | ||
| integration with Vault, cert-manager, external secrets, sealed secrets & Venafi tools for TLS/SSL and secrets | ||
| management. | ||
| - Slowly add support for ML development & ML frameworks to make it easy to develop ML applications that will run on | ||
| Kubernetes. | ||
| - **Automatically manage generated code for by auto creating the services catalog & their visualization by versioning | ||
| and integrations, and also git repo observability** | ||
| - **please suggest what you would like to add as features** | ||
|
|
||
| ------------------------- | ||
|
|
||
| #### Current features in compage | ||
| - An opensource tool that runs on your local cluster (mostly a local cluster running on developer's machine), helps to | ||
| visually develop backend workloads for cloud-native & K8s. | ||
| - Easy to adopt & use. | ||
| - GitHub Actions, container build tools, cosign, etc. | ||
| - Auto-generate code for backend workloads like Rest API. | ||
| - Auto-generate the backend code, based on requirements defined via diagram & forms. | ||
| - Auto build containers as multi-stage and/or distro-less to make them secure, portable and optimal. | ||
| - Automatically enforce software supply chain security process like generating cosign configuration in GitHub actions | ||
| for generated source code for the diagrams drawn, generating deepsource configurations, generating configurations for | ||
| deployments, services etc. in K8s env. | ||
|
|
||
| #### Languages supported: | ||
|
|
||
| > OpenApi Generator based templates (REST) | ||
| - GoLang | ||
| - Java | ||
| - Python | ||
| - JavaScript | ||
| - Ruby | ||
| - **we would like to add more support to different languages. Please feel free to suggest.** | ||
|
|
||
| > Compage managed templates (REST) | ||
| - Go | ||
| - Rust (in progress) | ||
|
|
||
| Support of different programming languages, protocols and frameworks will be added one by one with community | ||
| contribution. | ||
|
|
||
| #### How to use Compage? | ||
|
|
||
| - A user can download the compage executable binary from releases page suitable for the user's machine architecture. The user can even build the binary from source code. | ||
| - Once the binary is downloaded, user can create a yaml file as configuration to be supplied to compage binary. The yaml file can be created by running the command `compage init` and then user can edit the yaml file to add the required configuration. | ||
| ## Architecture | ||
|
|
||
| ## Contributing | ||
|
|
||
| You are warmly welcome to contribute to Compage. | ||
| Please refer the detailed guide [CONTRIBUTING.md](./CONTRIBUTING.md). | ||
|
|
||
| ## Community | ||
|
|
||
| Active communication channels | ||
|
|
||
| - Discord: [Discord](https://discord.gg/DeapQc22qe) | ||
|
|
||
| ## License | ||
|
|
||
| Refer the licence - [LICENCE](./LICENSE). | ||
|
|
||
| ## Star History | ||
|
|
||
| <a href="https://star-history.com/#intelops/compage&Timeline"> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=intelops/compage&type=Date&theme=dark" /> | ||
| <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=intelops/compage&type=Date" /> | ||
| <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=intelops/compage&type=Date" /> | ||
| </picture> | ||
| </a> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.