diff --git a/README.md b/README.md index bc37e6cab..7c427f11a 100644 --- a/README.md +++ b/README.md @@ -14,19 +14,27 @@ -Conductor is a platform _originally_ created at **Netflix** to orchestrate microservices and events. -[Conductor OSS](https://conductor-oss.org) is maintained by the team of developers at [Orkes.io](https://orkes.io/) along with members of the open source community. +Conductor is a platform _originally_ created at **Netflix** to orchestrate microservices and events. [Conductor OSS](https://conductor-oss.org) is maintained by the team of developers at [Orkes.io](https://orkes.io/) along with members of the open source community. + + +[![conductor_oss_getting_started](https://github.com/user-attachments/assets/6153aa58-8ad1-4ec5-93d1-38ba1b83e3f4)](https://youtu.be/4azDdDlx27M) - - - # Table of Contents 1. [What is Conductor?](#what-is-conductor) * [Key benefits](#key-benefits) * [Features](#features) -2. [Requirements](#requirements) -3. [Conductor Roadmap](#conductor-oss-roadmap) -4. [How to Contribute](#contributors) -5. [Additional Resources](#resources) -6. [Community & Support](#slack-community) +2. [Getting Started](#getting-started) + * [Requirements](#requirements) + * [Quick Start](#quick-start-guide) + * [Create your first workflow](#create-your-first-workflow) +3. [Documentation](#documentation) +4. [Database Specifications](#database-specifications) +5. [Deployment Options](#deployment-options) +6. [Conductor Roadmap](#conductor-oss-roadmap) +7. [How to Contribute](#contributors) +8. [Additional Resources](#resources) +9. [Community & Support](#slack-community) # What is Conductor? Conductor (or [Netflix Conductor](https://netflixtechblog.com/netflix-conductor-a-microservices-orchestrator-2e8d4771bf40)) is a microservices orchestration engine for distributed and asynchronous workflows. It empowers developers to create workflows that define interactions between services, databases, and other external systems. @@ -53,6 +61,7 @@ Conductor is designed to enable flexible, resilient, and scalable workflows. It * Install Java (JDK) 17 or newer * Node 14 for the UI to build * _Earlier versions may work, but are untested_ + ## Quick Start Guide @@ -82,12 +91,15 @@ docker compose -f docker/docker-compose.yaml up ##### Or use the REST API with your preferred HTTP client * http://localhost:8080 -## Database Requirements - +# Documentation +Check-out the [Conductor OSS docs](https://github.com/conductor-oss/conductor/tree/main/docs) for additional details +- - - +# Database Specifications * The default persistence used is Redis * The indexing backend is [Elasticsearch](https://www.elastic.co/) (7.x) -## Configuration for various database backends + +### Configuration for various database backends | Backend | Configuration | |----------------|---------------------------------------------------------------------------------------| @@ -97,7 +109,6 @@ docker compose -f docker/docker-compose.yaml up | MySQL + ES7 | [config-mysql.properties](docker/server/config/config-mysql.properties) | -- - - # Deployment Options In addition to the Docker Compose setup, Netflix Conductor supports several other deployment methods to suit various environments: @@ -114,19 +125,26 @@ Conductor provides several SDKs for interacting with the API and creating custom Each SDK is maintained as part of the Conductor project, providing examples and comprehensive API documentation. -# Documentation and Community -* **Official Documentation:** [Conductor documentation](https://docs.conductor-oss.org/index.html) contains detailed explanations of workflow concepts, API reference, and guides. -* **Conductor Slack:** [Join the Conductor Slack](https://join.slack.com/t/orkes-conductor/shared_invite/zt-2hmxn0i3n-_W~a9rWMbvMoYmlJo3Y15g) channel for community discussions and support. -* **Orkes Community Discourse:** [Hosted by Orkes.io](https://community.orkes.io) on Discourse, you can engage the Conductor & Orkes community, ask questions, and contribute ideas. - - # Conductor OSS Roadmap [See the roadmap for the Conductor](ROADMAP.md) - If you would like to participate in the roadmap and development, [please reach out](https://forms.gle/P2i1xHrxPQLrjzTB7). +# Documentation and Community +* **Official Documentation:** [Conductor documentation](https://docs.conductor-oss.org/index.html) contains detailed explanations of workflow concepts, API reference, and guides. +* **Conductor Slack:** [Join the Conductor Slack](https://join.slack.com/t/orkes-conductor/shared_invite/zt-2hmxn0i3n-_W~a9rWMbvMoYmlJo3Y15g) channel for community discussions and support. +* **Orkes Community Discourse:** [Hosted by Orkes.io](https://community.orkes.io) on Discourse, you can engage the Conductor & Orkes community, ask questions, and contribute ideas. +- - - # License Conductor is licensed under the Apache 2.0 License © [Conductor Open-source](https://conductor-oss.org/) +- - - +# Contributing + +We welcome contributions from everyone! + +- **Report Issues:** Found a bug or have a feature request? Open an [issue on GitHub](https://github.com/conductor-oss/conductor/issues). +- **Contribute Code:** Check out our [Contribution Guide](https://github.com/conductor-oss/conductor/blob/main/CONTRIBUTING.md) for initial guidelines, and explore our [good first issues](https://github.com/conductor-oss/conductor/labels/good%20first%20issue) for beginner-friendly tasks to tackle first. +- **Build a Conductor SDK:** Need an SDK not included with Conductor? Build your own using the [Swagger API](http://localhost:8080) included with your local deployment. +- **Contribute to our Docs:** Contribute edits or updates to keep our [documentation](https://github.com/conductor-oss/conductor/tree/main/docs) in great shape for the community. ## Contributors