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

Adding change log blurb #22

Merged
merged 11 commits into from
May 18, 2022
Prev Previous commit
Next Next commit
add readmes. Fix broken links
  • Loading branch information
cartersocha committed May 17, 2022
commit 050894077c5220d05803b84867f91de41636a42a
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,21 @@ See the [Development Principles](/docs/development-principles.md) doc for more i

[![Architecture of microservices](./docs/img/architecture-diagram.png)](./docs/img/architecture-diagram.png)

Find **Protocol Buffers Descriptions** at the [`./pb` directory](./pb).
Find **Protocol Buffers Descriptions** at the [`./pb` directory](./pb/README.md).

| Service | Language | Description |
| ---------------------------------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| [frontend](./src/frontend) | Go | Exposes an HTTP server to serve the website. Does not require signup/login and generates session IDs for all users automatically. |
| [cartservice](./src/cartservice) | C# | Stores the items in the user's shopping cart in Redis and retrieves it. |
| [productcatalogservice](./src/productcatalogservice) | Go | Provides the list of products from a JSON file and ability to search products and get individual products. |
| [currencyservice](./src/currencyservice) | Node.js | Converts one money amount to another currency. Uses real values fetched from European Central Bank. It's the highest QPS service. |
| [paymentservice](./src/paymentservice) | Node.js | Charges the given credit card info (mock) with the given amount and returns a transaction ID. |
| [shippingservice](./src/shippingservice) | Go | Gives shipping cost estimates based on the shopping cart. Ships items to the given address (mock) |
| [emailservice](./src/emailservice) | Python | Sends users an order confirmation email (mock). |
| [checkoutservice](./src/checkoutservice) | Go | Retrieves user cart, prepares order and orchestrates the payment, shipping and the email notification. |
| [recommendationservice](./src/recommendationservice) | Python | Recommends other products based on what's given in the cart. |
| [adservice](./src/adservice) | Java | Provides text ads based on given context words. |
| [loadgenerator](./src/loadgenerator) | Python/Locust | Continuously sends requests imitating realistic user shopping flows to the frontend. |
| [frontend](./src/frontend/README.md) | Go | Exposes an HTTP server to serve the website. Does not require signup/login and generates session IDs for all users automatically. |
| [cartservice](./src/cartservice/README.md) | C# | Stores the items in the user's shopping cart in Redis and retrieves it. |
| [productcatalogservice](./src/productcatalogservice/README.md) | Go | Provides the list of products from a JSON file and ability to search products and get individual products. |
| [currencyservice](./src/currencyservice/README.md) | Node.js | Converts one money amount to another currency. Uses real values fetched from European Central Bank. It's the highest QPS service. |
| [paymentservice](./src/paymentservice/README.md) | Node.js | Charges the given credit card info (mock) with the given amount and returns a transaction ID. |
| [shippingservice](./src/shippingservice/README.md) | Go | Gives shipping cost estimates based on the shopping cart. Ships items to the given address (mock) |
| [emailservice](./src/emailservice/README.md) | Python | Sends users an order confirmation email (mock). |
| [checkoutservice](./src/checkoutservice/README.md) | Go | Retrieves user cart, prepares order and orchestrates the payment, shipping and the email notification. |
| [recommendationservice](./src/recommendationservice/README.md) | Python | Recommends other products based on what's given in the cart. |
| [adservice](./src/adservice/README.md) | Java | Provides text ads based on given context words. |
| [loadgenerator](./src/loadgenerator/README.md) | Python/Locust | Continuously sends requests imitating realistic user shopping flows to the frontend. |

## Features

Expand Down
3 changes: 3 additions & 0 deletions pb/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Read Me

This is a placeholder
3 changes: 3 additions & 0 deletions src/cartservice/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Read Me

This is a placeholder
3 changes: 3 additions & 0 deletions src/currencyservice/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Read Me

This is a placeholder
3 changes: 3 additions & 0 deletions src/emailservice/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Read Me

This is a placeholder
3 changes: 3 additions & 0 deletions src/loadgenerator/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Read Me

This is a placeholder
3 changes: 3 additions & 0 deletions src/otelcollector/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Read Me

This is a placeholder
3 changes: 3 additions & 0 deletions src/paymentservice/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Read Me

This is a placeholder
3 changes: 3 additions & 0 deletions src/recommendationservice/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Read Me

This is a placeholder