You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-**Easy to Use**: The Serverless Workflow DSL is designed for universal understanding, enabling users to quickly grasp workflow concepts and create complex workflows effortlessly.
@@ -33,7 +37,7 @@ With Synapse, you can create powerful workflows that are cloud vendor-agnostic,
33
37
-**Scalable**: Promotes code reusability, maintainability, and scalability across different environments.
34
38
-**Cross-Platform**: Runs on various operating systems, providing flexibility and ease of integration.
35
39
36
-
### Microservices
40
+
### Architecture
37
41
38
42
Synapse is composed of several specialized applications, allowing for atomic scalability, resilience, and ease of maintenance:
39
43
@@ -43,6 +47,12 @@ Synapse is composed of several specialized applications, allowing for atomic sca
43
47
-**Correlator**: Performs Complex Event Processing (CEP) and correlates ingested events.
44
48
-**CLI**: Allows interaction with the Synapse API via the command line interface.
*For more information about the Synapse architecture, please refer to the [wiki](https://github.com/serverlessworkflow/synapse/wiki/Architecture).* 📖
55
+
46
56
## Getting Started
47
57
48
58
### Prerequisites
@@ -79,6 +89,8 @@ The simplest way to get started is by using the provided Docker Compose setup.
79
89
80
90
This will pull the necessary Docker images and start the Synapse services as defined in the `docker-compose.yml` file. You can then access the Synapse API and dashboard as configured.
81
91
92
+
*For more information about installing Synapse, please refer to the [wiki](https://github.com/serverlessworkflow/synapse/wiki/Installation)*. 📖
93
+
82
94
### Run using `synctl` Command-line Interface
83
95
84
96
First, set up the Synapse API server to use with `synctl`:
@@ -120,15 +132,15 @@ The command above will provide the fully qualified name of the created workflow
For more information about `synctl`, please refer to the [documentation](#synctl).
135
+
*For more information about `synctl`, please refer to the [wiki](https://github.com/serverlessworkflow/synapse/wiki/CLI-Usage).* 📖
124
136
125
137
## Community
126
138
127
139
The Synapse project has a vibrant and growing community dedicated to building a community-driven and vendor-neutral workflow runtime ecosystem. Contributions from the community are encouraged and essential to the continued growth and success of the project.
128
140
129
-
A list of community members who have contributed to Synapse can be found [here](./community/README.md).
141
+
A list of community members who have contributed to Synapse can be found [here](./community/README.md). 👥
130
142
131
-
To learn how to contribute to Synapse, please refer to the [contribution guidelines](CONTRIBUTING.md).
143
+
To learn how to contribute to Synapse, please refer to the [contribution guidelines](CONTRIBUTING.md). 📝
132
144
133
145
For any copyright-related questions when contributing to a CNCF project like Synapse, please refer to the [Ownership of Copyrights in CNCF Project Contributions](https://github.com/cncf/foundation/blob/master/copyright-notices.md) document.
134
146
@@ -138,5 +150,5 @@ As contributors and maintainers of Synapse, and in the interest of fostering an
138
150
139
151
The project is committed to making participation in Synapse a harassment-free experience for everyone, regardless of experience level, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
140
152
141
-
For more detailed information, please see the full project Code of Conduct [here](code-of-conduct.md).
153
+
For more detailed information, please see the full project Code of Conduct [here](code-of-conduct.md). 🛡️
0 commit comments