Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Update readme with juspay's vision, product offering, architecture diagram, setup steps and output #7024

Merged
merged 14 commits into from
Jan 17, 2025
Merged
119 changes: 46 additions & 73 deletions README.md
Original file line number Diff line number Diff line change
@@ -3,22 +3,11 @@
<img src="./docs/imgs/hyperswitch-logo-light.svg#gh-light-mode-only" alt="Hyperswitch-Logo" width="40%" />
</p>

<h1 align="center">The open-source payments switch</h1>
<h1 align="center">Open-Source Payments Orchestration</h1>

<div align="center" >
The single API to access payment ecosystems across 130+ countries</div>

<p align="center">
<a href="#try-a-payment">Try a Payment</a> •
<a href="#quick-setup">Quick Setup</a> •
<a href="/docs/try_local_system.md">Local Setup Guide (Hyperswitch App Server)</a> •
<a href="https://api-reference.hyperswitch.io/introduction"> API Docs </a>
<br>
<a href="#community-contributions">Community and Contributions</a> •
<a href="#bugs-and-feature-requests">Bugs and feature requests</a> •
<a href="#versioning">Versioning</a> •
<a href="#copyright-and-license">Copyright and License</a>
</p>
Single API to access the payments ecosystem and its features
</div>

<p align="center">
<a href="https://github.com/juspay/hyperswitch/actions?query=workflow%3ACI+branch%3Amain">
@@ -45,52 +34,51 @@ The single API to access payment ecosystems across 130+ countries</div>

<hr>

Hyperswitch is a community-led, open payments switch designed to empower digital businesses by providing fast, reliable, and affordable access to the best payments infrastructure.
Juspay, founded in 2012, is a global leader in payment orchestration and checkout solutions, trusted by 400+ leading enterprises and brands worldwide. Hyperswitch is Juspay's new generation of composable, commercial open-source payments platform for merchant and brands. It is an enterprise-grade, transparent and modular payments platform designed to provide digital businesses access to the best payments infrastructure.

Here are the components of Hyperswitch that deliver the whole solution:
Here are the key components of Hyperswitch that deliver the whole solution:

* [Hyperswitch Backend](https://github.com/juspay/hyperswitch): Powering Payment Processing
* [Hyperswitch Backend](https://github.com/juspay/hyperswitch): Hyperswitch backend enables seamless payment processing with comprehensive support for various payment flows - authorization, authentication, void and capture workflows along with robust management of post-payment processes like refunds and chargeback handling. Additionally, Hyperswitch supports non-payment use cases by enabling connections with external FRM or authentication providers as part of the payment flow. The backend optimizes payment routing with customizable workflows, including success rate-based routing, rule-based routing, volume distribution, fallback handling, and intelligent retry mechanisms for failed payments based on specific error codes.

* [SDK (Frontend)](https://github.com/juspay/hyperswitch-web): Simplifying Integration and Powering the UI
* [SDK (Frontend)](https://github.com/juspay/hyperswitch-web): The SDK, available for web, [Android, and iOS](https://github.com/juspay/hyperswitch-client-core), unifies the payment experience across various methods such as cards, wallets, BNPL, bank transfers, and more, while supporting the diverse payment flows of underlying PSPs. When paired with the locker, it surfaces the user's saved payment methods.

* [Control Centre](https://github.com/juspay/hyperswitch-control-center): Managing Operations with Ease
* [Control Center](https://github.com/juspay/hyperswitch-control-center): The Control Center enables users to manage the entire payments stack without any coding. It allows the creation of workflows for routing, payment retries, and defining conditions to invoke 3DS, fraud risk management (FRM), and surcharge modules. The Control Center provides access to transaction, refund, and chargeback operations across all integrated PSPs, transaction-level logs for initial debugging, and detailed analytics and insights into payment performance.

Jump in and contribute to these repositories to help improve and expand Hyperswitch!
Read more at [Hyperswitch docs](https://docs.hyperswitch.io/).

<img src="./docs/imgs/switch.png" />
<img src="./docs/imgs/features.png" />
<img src="./docs/imgs/non-functional-features.png" />

<img src="./docs/imgs/hyperswitch-architecture-v1.png" />

<a href="#Quick Setup">
<h2 id="quick-setup">⚡️ Quick Setup</h2>
<a href="#Try Hyperswitch">
<h2 id="Try Hyperswitch">Try Hyperswitch</h2>
</a>

### Docker Compose

You can run Hyperswitch on your system using Docker Compose after cloning this repository:
### 1. Local Setup

```shell
git clone --depth 1 --branch latest https://github.com/juspay/hyperswitch
cd hyperswitch
docker compose up -d
```
You can run Hyperswitch on your system using Docker compose after cloning this repository. Check out the [local setup guide][local-setup-guide] for a more details on setting up the entire stack or component wise. This takes 15-mins and gives the following output
<img src="./docs/imgs/local-setup-output.png" />

This will start the app server, web client/SDK and control center.
### 2. Deployment on cloud

Check out the [local setup guide][local-setup-guide] for a more comprehensive
setup, which includes the [scheduler and monitoring services][docker-compose-scheduler-monitoring].

### One-click deployment on AWS cloud

The fastest and easiest way to try Hyperswitch is via our CDK scripts
The fastest and easiest way to try Hyperswitch on AWS is via our CDK scripts

1. Click on the following button for a quick standalone deployment on AWS, suitable for prototyping.
No code or setup is required in your system and the deployment is covered within the AWS free-tier setup.

<a href="https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/new?stackName=HyperswitchBootstarp&templateURL=https://hyperswitch-synth.s3.eu-central-1.amazonaws.com/hs-starter-config.yaml"><img src="./docs/imgs/aws_button.png" height="35"></a>
<a href="https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/new?stackName=HyperswitchBootstarp&templateURL=https://hyperswitch-synth.s3.eu-central-1.amazonaws.com/hs-starter-config.yaml"><img src="https://github.com/juspay/hyperswitch/blob/main/docs/imgs/aws_button.png?raw=true" height="35"></a>

2. Sign-in to your AWS console.

3. Follow the instructions provided on the console to successfully deploy Hyperswitch
3. Follow the instructions provided on the console to successfully deploy Hyperswitch. This takes 30-45mins and gives the following output
<img src="./docs/imgs/cdk-output.png" />

We support deployment on GCP and Azure via Helm charts which takes 30-45mins. You can read more at [Hyperswitch docs](https://docs.hyperswitch.io/hyperswitch-open-source/deploy-on-kubernetes-using-helm).

### 3. Hosted Sandbox

You can experience the product by signing up for our [hosted sandbox](https://app.hyperswitch.io/). The signup process accepts any email ID and provides access to the entire Control Center. You can set up connectors, define workflows for routing and retries, and even try payments from the dashboard.

[docs-link-for-enterprise]: https://docs.hyperswitch.io/hyperswitch-cloud/quickstart
[docs-link-for-developers]: https://docs.hyperswitch.io/hyperswitch-open-source/overview
@@ -101,43 +89,27 @@ The fastest and easiest way to try Hyperswitch is via our CDK scripts
[local-setup-guide]: /docs/try_local_system.md
[docker-compose-scheduler-monitoring]: /docs/try_local_system.md#running-additional-services

<a href="https://app.hyperswitch.io/">
<h2 id="try-a-payment">⚡️ Try a Payment</h2>
</a>

To quickly experience the ease of Hyperswitch, sign up on the [Hyperswitch Control Center](https://app.hyperswitch.io/) and try a payment. Once you've completed your first transaction, you’ve successfully made your first payment with Hyperswitch!

<a href="#community-contributions">
<h2 id="community-contributions">✅ Community & Contributions</h2>
<a href="Support & Feature requests">
<h2 id="Support & Feature requests">Support & Feature requests</h2>
</a>

The community and core team are available in [GitHub Discussions](https://github.com/juspay/hyperswitch/discussions), where you can ask for support, discuss roadmap, and share ideas.
For new product features, enhancements, roadmap discussions, or to share queries and ideas, visit our [GitHub Discussions](https://github.com/juspay/hyperswitch/discussions)

Our [Contribution Guide](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) describes how to contribute to the codebase and Docs.
For any support, join the conversation in [Slack](https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw)

Join our Conversation in [Slack](https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw), [Discord](https://discord.gg/wJZ7DVW8mm), [Twitter](https://x.com/hyperswitchio)


<a href="#Join-us-in-building-Hyperswitch">
<h2 id="join-us-in-building-hyperswitch">💪 Join us in building Hyperswitch</h2>
<a href="Our Vision">
<h2 id="Our Vision">Our Vision</h2>
</a>

### 🤝 Our Belief
> Linux for Payments
> Payments should be open, fast, reliable and affordable to serve
> the billions of people at scale.
Payments are evolving rapidly worldwide, with hundreds of processors, fraud detection systems, authentication modules, and new payment methods and flows emerging. Businesses building or managing their own payment stacks often face similar challenges, struggle with comparable issues, and find it hard to innovate at the desired pace.

Globally payment diversity has been growing at a rapid pace.
There are hundreds of payment processors and new payment methods like BNPL,
RTP etc.
Businesses need to embrace this diversity to increase conversion, reduce cost
and improve control.
But integrating and maintaining multiple processors needs a lot of dev effort.
Why should devs across companies repeat the same work?
Why can't it be unified and reused? Hence, Hyperswitch was born to create that
reusable core and let companies build and customise it as per their specific requirements.
Hyperswitch serves as a well-architected designed reference platform, built on best-in-class design principles, empowering businesses to own and customize their payment stack. It provides a reusable core payments stack that can be tailored to specific requirements while relying on the Hyperswitch team for enhancements, support, and continuous innovation.

### Our Values
### Our Values

1. Embrace Payments Diversity: It will drive innovation in the ecosystem in
multiple ways.
@@ -151,7 +123,7 @@ reusable core and let companies build and customise it as per their specific req
This project is being created and maintained by [Juspay](https://juspay.io)

<a href="#Bugs and feature requests">
<h2 id="bugs-and-feature-requests">🐞 Bugs and feature requests</h2>
<h2 id="bugs-and-feature-requests">Bugs and feature requests</h2>
</a>

Please read the issue guidelines and search for [existing and closed issues].
@@ -161,23 +133,24 @@ If your problem or idea is not addressed yet, please [open a new issue].
[open a new issue]: https://github.com/juspay/hyperswitch/issues/new/choose

<a href="#Versioning">
<h2 id="versioning">🔖 Versioning</h2>
<h2 id="versioning">Versioning</h2>
</a>

Check the [CHANGELOG.md](./CHANGELOG.md) file for details.

<a href="#©Copyright and License">
<h2 id="copyright-and-license">©️ Copyright and License</h2>
<h2 id="copyright-and-license">Copyright and License</h2>
</a>

This product is licensed under the [Apache 2.0 License](LICENSE).

<a href="#Thanks to all contributors">
<h2 id="Thanks to all contributors">✨ Thanks to all contributors</h2>

<a href="Team behind Hyperswitch">
<h2 id="Team behind Hyperswitch">Team behind Hyperswitch</h2>
</a>

Thank you for your support in hyperswitch's growth. Keep up the great work! 🥂
The core team of 150+ engineers building Hyperswitch. Keep up the great work! 🥂

<a href="https://github.com/juspay/hyperswitch/graphs/contributors">
<img src="https://contributors-img.web.app/image?repo=juspay/hyperswitch" alt="Contributors"/>
</a>
</a>
Binary file added docs/imgs/cdk-output.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/imgs/features.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/imgs/hyperswitch-architecture-v1.png
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also, do you think the hyperswitch logo in the architecture diagram is still relevant given that we've removed it else where? same applies to the logo in the switch-v1.png

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/imgs/local-setup-output.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/imgs/non-functional-features.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.