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

docs(try_local_system): add instructions to run using Docker Compose by pulling standalone images #2984

Merged
merged 9 commits into from
Nov 27, 2023

Conversation

SanchithHegde
Copy link
Member

Type of Change

  • Bugfix
  • New feature
  • Enhancement
  • Refactoring
  • Dependency updates
  • Documentation
  • CI/CD

Description

This PR adds a section in the local setup guide to include instructions to run using Docker Compose by pulling pre-compiled standalone Docker images.

To facilitate that, I've renamed the existing Docker Compose file to docker-compose-development.yml, and added a docker-compose.yml file which pulls standalone Docker images from Docker Hub. In addition, I've reorganized services in the Docker Compose files to have relevant services together.

Motivation and Context

Improving the local setup experience for anyone trying out hyperswitch on their system.

How did you test it?

By running Docker Compose, and by specifying multiple profiles.

Checklist

  • I formatted the code cargo +nightly fmt --all
  • I addressed lints thrown by cargo clippy
  • I reviewed the submitted code
  • I added unit tests for my changes where possible
  • I added a CHANGELOG entry if applicable

@SanchithHegde SanchithHegde added C-doc Category: Documentation updates S-waiting-on-review Status: This PR has been implemented and needs to be reviewed labels Nov 27, 2023
@SanchithHegde SanchithHegde self-assigned this Nov 27, 2023
@SanchithHegde SanchithHegde requested review from a team as code owners November 27, 2023 07:54
@SanchithHegde SanchithHegde added this pull request to the merge queue Nov 27, 2023
@SanchithHegde SanchithHegde removed the S-waiting-on-review Status: This PR has been implemented and needs to be reviewed label Nov 27, 2023
Merged via the queue into main with commit 0fa8ad1 Nov 27, 2023
10 of 12 checks passed
@SanchithHegde SanchithHegde deleted the docker-compose-standalone-images branch November 27, 2023 10:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-doc Category: Documentation updates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants