> For the complete documentation index, see [llms.txt](https://weplanx.gitbook.io/latest/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://weplanx.gitbook.io/latest/introduction.md).
# Hi, there.
Weplanx is an open source project that explores the combination of DevOps and LowCode.
You can easily manage resources, workflows, queues and IM (instant messaging), and can also be customized as the basic service of any distribution system.
The technology stack includes Golang, TypeScript, MongoDB, Redis and Nats, etc.
Developed based on [Hertz](https://github.com/cloudwego/hertz) and [Ng-Zorro-Antd](https://github.com/NG-ZORRO/ng-zorro-antd).
As a basic service, Weplanx can provide:
* Basic functions included in conventional systems
* Distribution of dynamic configuration sync ups
* Can be friendly to support low-code mongodb RESTFul
* Angular and Golang development support libraries for business customization
Weplanx architecture for medium-light applications, but needs to run on Kubernetes.
[Rancher K3s](https://www.rancher.com/products/k3s) recommended for deploying lightweight K8s, also need to prepare these:
* Computing node
* At least 3 nodes(2C4G) nodes form a K3s cluster, or 7 nodes are required for full self-host
* MongoDB
* Recommended version > = 5.0 (supports Time series)
* Production environment at least 2C4G replica cluster
* Atlas or public cloud can be preferred, self-built recommendation Percona Distribution for MongoDB
* Redis
* Recommended > = 256M
* Redis Cloud or public cloud can be preferred
* Nats
* Need to enable JetStream, [Helm](https://docs.nats.io/running-a-nats-service/nats-kubernetes) can be deployed to this cluster
### Case Overview
{% tabs %}
{% tab title="Login-1" %}
{% endtab %}
{% tab title="Login-2" %}
{% endtab %}
{% tab title="Login-3" %}
{% endtab %}
{% tab title="Forget" %}
{% endtab %}
{% endtabs %}
{% tabs %}
{% tab title="Center-1" %}
{% endtab %}
{% tab title="Center-2" %}
{% endtab %}
{% tab title="Center-3" %}
{% endtab %}
{% tab title="Center-4" %}
{% endtab %}
{% endtabs %}
{% tabs %}
{% tab title="Project-1" %}
{% endtab %}
{% tab title="Project-2" %}
{% endtab %}
{% tab title="Project-3" %}
{% endtab %}
{% tab title="Project-4" %}
{% endtab %}
{% endtabs %}
{% tabs %}
{% tab title="Cluster-1" %}
{% endtab %}
{% tab title="Cluster-2" %}
{% endtab %}
{% tab title="Cluster-3" %}
{% endtab %}
{% endtabs %}
{% tabs %}
{% tab title="Endpoint-1" %}
{% endtab %}
{% tab title="Endpoint-2" %}
{% endtab %}
{% tab title="Endpoint-3" %}
{% endtab %}
{% endtabs %}
{% tabs %}
{% tab title="Builder-1" %}
{% endtab %}
{% tab title="Builder-2" %}
{% endtab %}
{% tab title="Builder-3" %}
{% endtab %}
{% tab title="Builder-4" %}
{% endtab %}
{% tab title="Builder-5" %}
{% endtab %}
{% tab title="Builder-6" %}
{% endtab %}
{% endtabs %}
{% tabs %}
{% tab title="Workflow-1" %}
{% endtab %}
{% tab title="Workflow-2" %}
{% endtab %}
{% tab title="Workflow-3" %}
{% endtab %}
{% tab title="Workflow-4" %}
{% endtab %}
{% tab title="Workflow-5" %}
{% endtab %}
{% tab title="Workflow-6" %}
{% endtab %}
{% endtabs %}
{% tabs %}
{% tab title="Queue-1" %}
{% endtab %}
{% tab title="Queue-2" %}
{% endtab %}
{% tab title="Queue-3" %}
{% endtab %}
{% tab title="Queue-4" %}
{% endtab %}
{% endtabs %}
{% tabs %}
{% tab title="IMessage-1" %}
{% endtab %}
{% tab title="IMessage-2" %}
{% endtab %}
{% tab title="IMessage-3" %}
{% endtab %}
{% tab title="IMessage-4" %}
{% endtab %}
{% tab title="IMessage-5" %}
{% endtab %}
{% tab title="IMessage-6" %}
{% endtab %}
{% endtabs %}
{% tabs %}
{% tab title="Dataset-1" %}
{% endtab %}
{% tab title="Dataset-2" %}
{% endtab %}
{% tab title="Dataset-3" %}
{% endtab %}
{% tab title="Dataset-4" %}
{% endtab %}
{% endtabs %}
{% tabs %}
{% tab title="Monitor-1" %}
{% hint style="warning" %}
APM and RUNTIME have used Elastic APM solution
{% endhint %}
{% endtab %}
{% tab title="Monitor-2" %}
{% endtab %}
{% tab title="Monitor-3" %}
{% endtab %}
{% endtabs %}
{% tabs %}
{% tab title="Integrated-1" %}
{% endtab %}
{% tab title="Integrated-2" %}
{% endtab %}
{% tab title="Integrated-3" %}
{% endtab %}
{% tab title="Integrated-4" %}
{% endtab %}
{% endtabs %}
{% tabs %}
{% tab title="Setting-1" %}
{% endtab %}
{% tab title="Setting-2" %}
{% endtab %}
{% tab title="Setting-3" %}
{% endtab %}
{% tab title="Setting-4" %}
{% endtab %}
{% tab title="Audit" %}
{% endtab %}
{% endtabs %}
{% tabs %}
{% tab title="Picture-1" %}
{% endtab %}
{% tab title="Picture-2" %}
{% endtab %}
{% tab title="Picture-3" %}
{% endtab %}
{% tab title="Video" %}
{% endtab %}
{% endtabs %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://weplanx.gitbook.io/latest/introduction.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
