Skip to content

Commit

Permalink
docs(try_local_system): add instructions to run using Docker Compose …
Browse files Browse the repository at this point in the history
…by pulling standalone images (#2984)
  • Loading branch information
SanchithHegde authored Nov 27, 2023
1 parent 34953a0 commit 0fa8ad1
Show file tree
Hide file tree
Showing 4 changed files with 542 additions and 169 deletions.
44 changes: 26 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
<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>

<div align="center" >
Expand Down Expand Up @@ -35,7 +34,6 @@ The single API to access payment ecosystems across 130+ countries</div>
</a>
</p>


<hr>
<img src="./docs/imgs/switch.png" />

Expand All @@ -57,27 +55,42 @@ Using Hyperswitch, you can:
<h2 id="Quick Start Guide">⚡️ Quick Start Guide</h2>
</a>

<h3> One-click deployment on AWS cloud </h3>
### 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 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.

&emsp;&emsp; <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="./docs/imgs/aws_button.png" height="35"></a>

2. Sign-in to your AWS console.

3. Follow the instructions provided on the console to successfully deploy Hyperswitch

For an early access to the production-ready setup fill this <a href="https://forms.gle/v6ru55XDZFufVPnu9">Early Access Form</a>

### Run it on your system

You can run Hyperswitch on your system using Docker Compose after cloning this repository:

```shell
docker compose up -d
```

This will start the payments router, the primary component within Hyperswitch.

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].

[local-setup-guide]: /docs/try_local_system.md
[docker-compose-scheduler-monitoring]: /docs/try_local_system.md#run-the-scheduler-and-monitoring-services

<a href="#Fast-Integration-for-Stripe-Users">
<h2 id="Fast Integration for Stripe Users">🔌 Fast Integration for Stripe Users</h2>
</a>

If you are already using Stripe, integrating with Hyperswitch is fun, fast &
easy.
If you are already using Stripe, integrating with Hyperswitch is fun, fast & easy.
Try the steps below to get a feel for how quick the setup is:

1. Get API keys from our [dashboard].
Expand All @@ -96,9 +109,7 @@ Try the steps below to get a feel for how quick the setup is:
As of Sept 2023, we support 50+ payment processors and multiple global payment methods.
In addition, we are continuously integrating new processors based on their reach and community requests.
Our target is to support 100+ processors by H2 2023.
You can find the latest list of payment processors, supported methods, and
features
[here][supported-connectors-and-features].
You can find the latest list of payment processors, supported methods, and features [here][supported-connectors-and-features].

[supported-connectors-and-features]: https://hyperswitch.io/pm-list

Expand Down Expand Up @@ -252,12 +263,11 @@ We welcome contributions from the community. Please read through our
Included are directions for opening issues, coding standards, and notes on
development.

- We appreciate all types of contributions: code, documentation, demo creation, or something new way you want to contribute to us. We will reward every contribution with a Hyperswitch branded t-shirt.
- 🦀 **Important note for Rust developers**: We aim for contributions from the community
across a broad range of tracks. Hence, we have prioritised simplicity and code
readability over purely idiomatic code. For example, some of the code in core
functions (e.g., `payments_core`) is written to be more readable than
pure-idiomatic.
- We appreciate all types of contributions: code, documentation, demo creation, or some new way you want to contribute to us.
We will reward every contribution with a Hyperswitch branded t-shirt.
- 🦀 **Important note for Rust developers**: We aim for contributions from the community across a broad range of tracks.
Hence, we have prioritised simplicity and code readability over purely idiomatic code.
For example, some of the code in core functions (e.g., `payments_core`) is written to be more readable than pure-idiomatic.

<a href="#Community">
<h2 id="Community">👥 Community</h2>
Expand All @@ -269,7 +279,6 @@ Get updates on Hyperswitch development and chat with the community:
- [Slack workspace][slack] for questions related to integrating hyperswitch, integrating a connector in hyperswitch, etc.
- [GitHub Discussions][github-discussions] to drop feature requests or suggest anything payments-related you need for your stack.

[blog]: https://hyperswitch.io/blog
[discord]: https://discord.gg/wJZ7DVW8mm
[slack]: https://join.slack.com/t/hyperswitch-io/shared_invite/zt-1k6cz4lee-SAJzhz6bjmpp4jZCDOtOIg
[github-discussions]: https://github.com/juspay/hyperswitch/discussions
Expand Down Expand Up @@ -314,7 +323,6 @@ Check the [CHANGELOG.md](./CHANGELOG.md) file for details.

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>
Expand Down
Loading

0 comments on commit 0fa8ad1

Please sign in to comment.