Skip to content

Commit 056fbbc

Browse files
committed
Merge main
2 parents 63bb09b + c6c57c1 commit 056fbbc

File tree

731 files changed

+33414
-28315
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

731 files changed

+33414
-28315
lines changed

CHANGELOG.md

Lines changed: 355 additions & 0 deletions
Large diffs are not rendered by default.

Cargo.lock

Lines changed: 7 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Dockerfile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@ FROM debian:bookworm
4646
ARG CONFIG_DIR=/local/config
4747
ARG BIN_DIR=/local/bin
4848

49+
# Copy this required fields config file
50+
COPY --from=builder /router/config/payment_required_fields_v2.toml ${CONFIG_DIR}/payment_required_fields_v2.toml
51+
4952
# RUN_ENV decides the corresponding config file to be used
5053
ARG RUN_ENV=sandbox
5154

README.md

Lines changed: 42 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,13 @@ Single API to access the payments ecosystem and its features
4141
## Table of Contents
4242

4343
1. [Introduction](#introduction)
44-
2. [Architectural Overview](#architectural-overview)
45-
3. [Try Hyperswitch](#try-hyperswitch)
46-
4. [Support, Feature requests & Bugs](#support-feature-requests)
47-
5. [Our Vision](#our-vision)
48-
6. [Versioning](#versioning)
49-
7. [Copyright and License](#copyright-and-license)
44+
2. [Try Hyperswitch](#try-hyperswitch)
45+
3. [Architectural Overview](#architectural-overview)
46+
4. [Community & Contributions](#community-and-contributions)
47+
5. [Feature requests & Bugs](#feature-requests)
48+
6. [Our Vision](#our-vision)
49+
7. [Versioning](#versioning)
50+
8. [Copyright and License](#copyright-and-license)
5051

5152
<a href="#introduction">
5253
<h2 id="introduction">Introduction</h2>
@@ -63,33 +64,38 @@ Here are the key components of Hyperswitch that deliver the whole solution:
6364

6465
Read more at [Hyperswitch docs](https://docs.hyperswitch.io/).
6566

66-
<a href="#architectural-overview">
67-
<h2 id="architectural-overview">Architectural Overview</h2>
68-
</a>
69-
<img src="./docs/imgs/features.png" />
70-
<img src="./docs/imgs/non-functional-features.png" />
71-
72-
<img src="./docs/imgs/hyperswitch-architecture-v1.png" />
73-
7467
<a href="#try-hyperswitch">
7568
<h2 id="try-hyperswitch">Try Hyperswitch</h2>
7669
</a>
7770

7871
### 1. Local Setup
7972

80-
You can run Hyperswitch on your system using Docker compose after cloning this repository.
81-
We recommend using Docker Desktop (Or Orbstack) for Windows and Mac OS. On Linux, you can install Docker Engine directly.
73+
#### One-Click Setup (Recommended)
74+
75+
You can run Hyperswitch on your system with a single command using our one-click setup script:
76+
8277
```shell
8378
git clone --depth 1 --branch latest https://github.com/juspay/hyperswitch
8479
cd hyperswitch
85-
docker compose up -d
86-
# This script verifies the setup and provides links to the individual components.
87-
scripts/docker_output.sh
80+
scripts/setup.sh
8881
```
82+
83+
The above script will:
84+
- Check for prerequisites (Docker Compose/Podman)
85+
- Set up necessary configurations
86+
- Let you select a deployment profile:
87+
- **Standard**: Recommended - App server + Control Center + Web SDK.
88+
- **Full**: Standard + Monitoring + Scheduler.
89+
- **Standalone App Server**: Core services only (Hyperswitch server, PostgreSQL, Redis)
90+
- Start the selected services
91+
- Check service health
92+
- Provide access information
93+
8994
The next step is to [configure a connector][configure-a-connector] with the Hyperswitch Control Center and [try a payment][try-a-payment].
9095

9196
Check out the [local setup guide][local-setup-guide] for more details on setting up the entire stack or component wise.
9297

98+
9399
### 2. Deployment on cloud
94100

95101
The fastest and easiest way to try Hyperswitch on AWS is via our CDK scripts
@@ -117,6 +123,14 @@ We support deployment on GCP and Azure via Helm charts which takes 30-45mins. Yo
117123

118124
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.
119125

126+
<a href="#architectural-overview">
127+
<h2 id="architectural-overview">Architectural Overview</h2>
128+
</a>
129+
<img src="./docs/imgs/features.png" />
130+
<img src="./docs/imgs/non-functional-features.png" />
131+
132+
<img src="./docs/imgs/hyperswitch-architecture-v1.png" />
133+
120134
[docs-link-for-enterprise]: https://docs.hyperswitch.io/hyperswitch-cloud/quickstart
121135
[docs-link-for-developers]: https://docs.hyperswitch.io/hyperswitch-open-source/overview
122136
[contributing-guidelines]: docs/CONTRIBUTING.md
@@ -128,11 +142,17 @@ You can experience the product by signing up for our [hosted sandbox](https://ap
128142
[configure-a-connector]: https://docs.hyperswitch.io/hyperswitch-open-source/account-setup/using-hyperswitch-control-center#add-a-payment-processor
129143
[try-a-payment]: https://docs.hyperswitch.io/hyperswitch-open-source/account-setup/test-a-payment
130144

131-
<a href="support-feature-requests">
132-
<h2 id="support-feature-requests">Support, Feature requests & Bugs</h2>
145+
<a href="community-and-contributions">
146+
<h2 id="community-and-contributions">Community & Contributions</h2>
133147
</a>
134148

135-
For any support, join the conversation in [Slack](https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw)
149+
If you have any questions, feel free to drop them in our [Slack community](https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw).
150+
151+
We welcome contributors from around the world to help build Hyperswitch. To get started, please read our [contribution guidelines](contributing-guidelines).
152+
153+
<a href="feature-requests">
154+
<h2 id="feature-requests">Feature requests & Bugs</h2>
155+
</a>
136156

137157
For new product features, enhancements, roadmap discussions, or to share queries and ideas, visit our [GitHub Discussions](https://github.com/juspay/hyperswitch/discussions)
138158

0 commit comments

Comments
 (0)