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 2, 2024
1 parent a59a6a2 commit 30e62fc
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export default defineUserConfig({
editLinks: false,
editLinkText: "Help us improve this page!",
nav: [{ text: "Home", link: "/" }],
sidebar: ["/"],
sidebar: ["/", "/model/", "/design/"],
}),
head: [["link", { rel: "icon", href: "favicon.ico" }]],
bundler: viteBundler(),
Expand Down
Binary file added docs/.vuepress/public/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.
2 changes: 0 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ The project should apply as many techniques of ASP.NET MVC Core as possible. For

## Technical Stack

### Backend

- [ASP.NET Core 8.0](https://docs.microsoft.com/en-us/aspnet/core/?view=aspnetcore-8.0): A cross-platform, high-performance, open-source framework for building modern, cloud-based, Internet-connected applications.
- [htmx](https://htmx.org/): A JavaScript library that allows you to access AJAX, WebSockets, and Server-Sent Events directly in HTML, using attributes.
- [Alphine.js](https://alpinejs.dev/): A rugged, minimal framework for composing JavaScript behavior in your markup.
Expand Down
22 changes: 22 additions & 0 deletions docs/design/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# System Design

## High Level Design

The high level design of the system is based on the following components:

![Architecture Diagram](/RookieShop/system-design.png)

| No | Name | Usecase | Technology |
| --- | --------------- | ---------------------------------------------------------------------------------------------------- | ------------------------- |
| 0 | ingress | A reverse proxy that routes incoming requests to the appropriate service | Yarp |
| 1 | identity server | An authentication server that provides authentication and authorization services for the application | Duende IdentityServer 7.0 |
| 2 | store front | A user-facing website that allows customers to view, rate, and purchase products | Razor, htmx, Alphine.js |
| 3 | back office | An admin-facing website that allows administrators to manage products, categories, and customers | Next.js 14.0 |
| 4 | web api | A REST API that provides data to the user-facing and admin-facing websites | ASP.NET Core 8.0 |
| 5 | redis | A distributed lock manager, cache and cart storage | Redis |
| 6 | postgres | A relational database that stores the application's data and email outbox | Postgres, Marten |
| 7 | observability | A telemetry data collector that collects and exports telemetry data to the Aspire Dashboard | OpenTelemetry |

## C4 Model

> TODO: Add C4 Model
21 changes: 21 additions & 0 deletions docs/model/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Business Analysis

## Business Context

> TODO: Describe the business context of the model.
## Conceptual Model

> TODO: Add conceptual model.
## Entity Relationship Diagram

> TODO: Add entity relationship diagram.
## Event Storming

> TODO: Add event storming.
## Use Cases

> TODO: Add use cases.

0 comments on commit 30e62fc

Please sign in to comment.