Skip to content
This repository has been archived by the owner on Jul 12, 2024. It is now read-only.

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
foxminchan committed Jun 8, 2024
1 parent 8fecf12 commit d9f984b
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ RookieShop is a .NET Core web application training project demonstrating Clean A
- [Windows with Visual Studio](#windows-with-visual-studio)
- [Mac, Linux, \& Windows without Visual Studio](#mac-linux--windows-without-visual-studio)
- [Setup tools and dependencies](#setup-tools-and-dependencies)
- [Setup Stripe webhook](#setup-stripe-webhook)
- [Running the application](#running-the-application)
- [Testing](#testing)
- [CI/CD](#cicd)
Expand Down Expand Up @@ -79,10 +80,12 @@ Build an e-commerce web site with minimum functionality below:
- [Yarp](https://microsoft.github.io/reverse-proxy/)
- [OpenTelemetry](https://opentelemetry.io/)
- [NUKE](https://nuke.build/)
- [Semantic Kernel](aka.ms/semantic-kernel)
- [OpenAI](https://openai.com/)

## Software Architecture

<img loading="lazy" src="./img/architecture.png" alt="Software Architecture" width="100%" />
<img loading="lazy" src="./img/system-design.png" alt="Software Architecture" width="100%" />

| No | Name | Usecase | Technology |
| --- | --------------- | ---------------------------------------------------------------------------------------------------- | ----------------------------------------- |
Expand All @@ -94,6 +97,7 @@ Build an e-commerce web site with minimum functionality below:
| 6 | cache | A distributed lock manager, cache and cart storage | Redis |
| 7 | database | A relational database that stores the application's data and email outbox | Postgres, Marten |
| 8 | observability | A telemetry data collector that collects and exports telemetry data to the Aspire Dashboard | OpenTelemetry |
| 9 | openai | A language model that handles the natural language processing tasks | OpenAI |

## Getting Started

Expand All @@ -104,6 +108,8 @@ Build an e-commerce web site with minimum functionality below:
- Install .NET 8.0 SDK: [https://dotnet.microsoft.com/download](https://dotnet.microsoft.com/download)
- Install Node.js: [https://nodejs.org/en/download/](https://nodejs.org/en/download/)
- Install bun: [https://bun.sh/](https://bun.sh/)
- Install Stripe CLI: [https://stripe.com/docs/stripe-cli](https://stripe.com/docs/stripe-cli)
- Open AI API Key: [https://platform.openai.com/](https://platform.openai.com/)

#### Windows with Visual Studio

Expand Down Expand Up @@ -131,6 +137,14 @@ cd RookieShop
dotnet restore ./RookieShop.sln
```

### Setup Stripe webhook

```bash
stripe login

stripe listen --forward-to https://localhost:9000/api/stripe
```

### Running the application

> [!WARNING]
Expand Down
Binary file modified docs/.vuepress/public/assets/image/architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/design/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ The high level design of the system is based on the following components:
| 6 | cache | A distributed lock manager, cache and cart storage | Redis |
| 7 | database | A relational database that stores the application's data and email outbox | Postgres, Marten |
| 8 | observability | A telemetry data collector that collects and exports telemetry data to the Aspire Dashboard | OpenTelemetry |
| 9 | openai | A language model that handles the natural language processing tasks | OpenAI |

## Why BFF Authentication?

Expand Down
Binary file removed img/architecture.png
Binary file not shown.
Binary file added img/system-design.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d9f984b

Please sign in to comment.