Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
Co-authored-by: [email protected]
  • Loading branch information
jashmehta3300 committed Aug 10, 2023
1 parent d107891 commit 38ccc01
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,17 @@ MartianBank is a microservices demo application that simulates an app to allow c

<br />

# Hightlights

- Micro Services Architecture ​
- Helm based configurable deployments options​ (eg switching between HTTP and GRPC)​
- Docker, Kind and EKS based easy installations​
- Swagger APIs and comprehensive documentation​
- Performance tests and load generation capabilities​
- Integration with other opensource projects like APIClarity

<br />

# Table of Contents
- [Application Design](#application-design)
- [Getting Started](#installation)
Expand All @@ -14,7 +25,6 @@ MartianBank is a microservices demo application that simulates an app to allow c
- [Installation on KIND Cluster](#3-installatioin-on-kind-cluster)
- [Installation on AWS EKS Cluster](#4-installation-on-aws-eks-cluster)
- [Running Locally](#5-local-installation)
- [Highlights](#highlights)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
Expand Down Expand Up @@ -75,7 +85,7 @@ data:
When running Docker or pods, use `"mongodb://root:example@mongodb:27017"` for the local database.
**`NOTE:`** You can change the mongoDB password to some value other than `example` in the above URL. To do this, you can edit `/martianbank/templates/configmap.yaml`.
**`NOTE:`** We recommend to change the mongoDB password to some value other than `example` in the above URL. To do this, you can edit `/martianbank/templates/configmap.yaml`.

#### Step 2: Install MartianBank using Helm
Now that you have the MartianBank repository downloaded, you can use Helm to install the app on your Kubernetes cluster.
Expand Down Expand Up @@ -417,18 +427,6 @@ bash stop_local.sh

<br />

# Hightlights

- Micro Services Architecture ​
- Helm based configurable deployments options​ (eg switching between HTTP and GRPC)​
- Docker, Kind and EKS based easy installations​
- Swagger APIs and comprehensive documentation​
- Performance tests and load generation capabilities​
- ETI lab deployer with Panoptica​
- Opensource

<br />

# Roadmap

- Images for background, coin, card, and map.
Expand Down

0 comments on commit 38ccc01

Please sign in to comment.