docs: update docs

.github/workflows/deploy-docs.yml

@@ -0,0 +1,40 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  deploy-gh-pages:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Install Deps
+        run: npm ci
+
+      - name: Build Docs
+        env:
+          NODE_OPTIONS: --max_old_space_size=8192
+        run: |-
+          npm run docs:build
+          > docs/.vuepress/dist/.nojekyll
+
+      - name: Deploy Docs
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: docs/.vuepress/dist

.gitignore

@@ -7,11 +7,6 @@ aspirate-state.json
 
 # Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
 
-# VuePress files
-**/.vuepress/.cache/
-**/.vuepress/.temp/
-**/.vuepress/dist/
-
 # Logs
 
 logs
@@ -142,11 +137,15 @@ dist
 
 # vuepress build output
 
-.vuepress/dist
+**/.vuepress/.cache/
+**/.vuepress/.temp/
+**/.vuepress/dist/
 
 # vuepress v2.x temp and cache directory
 
 .temp
+.cache/
+docs/.vuepress/**/deps
 
 # Docusaurus cache and generated files
 

README.md

@@ -66,6 +66,7 @@ Build an e-commerce web site with minimum functionality below:
 
 - [ASP.NET Core 8.0](https://docs.microsoft.com/en-us/aspnet/core/?view=aspnetcore-8.0)
 - [htmx](https://htmx.org/)
+- [Alphine.js](https://alpinejs.dev/)
 - [Next.js 14.0](https://nextjs.org/)
 - [Duende IdentityServer 7.0](https://duendesoftware.com/products/identityserver)
 - [Redis](https://redis.io/)

docs/.vuepress/config.js

@@ -1,18 +1,25 @@
-import { defaultTheme } from '@vuepress/theme-default'
-import { defineUserConfig } from 'vuepress/cli'
-import { viteBundler } from '@vuepress/bundler-vite'
+import { defaultTheme } from "@vuepress/theme-default";
+import { defineUserConfig } from "vuepress/cli";
+import { viteBundler } from "@vuepress/bundler-vite";
 
 export default defineUserConfig({
-  lang: 'en-US',
+  lang: "en-US",
 
-  title: 'VuePress',
-  description: 'My first VuePress Site',
+  base: "/RookieShop/",
+  title: "RookieShop",
+  description:
+    "A project developed by a rookie transitioning to an engineer at NashTech",
 
   theme: defaultTheme({
-    logo: 'https://vuejs.press/images/hero.png',
-
-    navbar: ['/', '/get-started'],
+    displayAllHeaders: true,
+    logo: "/logo.png",
+    docsDir: "docs",
+    repo: "foxminchan/RookieShop",
+    editLinks: false,
+    editLinkText: "Help us improve this page!",
+    nav: [{ text: "Home", link: "/" }],
+    sidebar: ["/"],
   }),
-
+  head: [["link", { rel: "icon", href: "favicon.ico" }]],
   bundler: viteBundler(),
-})
+});

docs/README.md

@@ -1,33 +1,57 @@
----
-home: true
-title: Home
-heroImage: https://vuejs.press/images/hero.png
-actions:
-  - text: Get Started
-    link: /getting-started.html
-    type: primary
-
-  - text: Introduction
-    link: https://vuejs.press/guide/introduction.html
-    type: secondary
-
-features:
-  - title: Simplicity First
-    details: Minimal setup with markdown-centered project structure helps you focus on writing.
-  - title: Vue-Powered
-    details: Enjoy the dev experience of Vue, use Vue components in markdown, and develop custom themes with Vue.
-  - title: Performant
-    details: VuePress generates pre-rendered static HTML for each page, and runs as an SPA once a page is loaded.
-  - title: Themes
-    details: Providing a default theme out of the box. You can also choose a community theme or create your own one.
-  - title: Plugins
-    details: Flexible plugin API, allowing plugins to provide lots of plug-and-play features for your site.
-  - title: Bundlers
-    details: Default bundler is Vite, while Webpack is also supported. Choose the one you like!
-
-footer: MIT Licensed | Copyright © 2018-present VuePress Community
----
-
-This is the content of home page. Check [Home Page Docs][default-theme-home] for more details.
-
-[default-theme-home]: https://vuejs.press/reference/default-theme/frontmatter.html#home-page
+# Introduction
+
+## Description
+
+<p align="justify">
+Rookie Shop is a .NET Core web application training project demonstrating Clean Architecture, DDD, and modern web development using Aspire and Next.js. It is part of the Rookie Phase-1 Assignment at NashTech.
+</p>
+
+<p align="justify">
+Rookie Shop uses Clean Architecture and DDD to ensure maintainability, scalability, and effective communication between developers and domain experts. It also integrates Aspire, a mature framework, to streamline development and provide a robust foundation for building modern web applications.
+</p>
+
+<p align="justify">
+Rookie Shop uses Next.js to enhance performance, provide an intuitive development experience, and create dynamic, responsive web interfaces.
+</p>
+
+## Requirements
+
+Build an e-commerce web site with minimum functionality below:
+
+**For customers:**
+
+- `Home page: category menu, features products`
+- `View products by category`
+- `View product details`
+- `Product rating`
+- Register
+- Login/Logout
+- Optional (Shopping Cart, Ordering, IdentityServer4)
+
+**For admin:**
+
+- Login/logout
+- `Manage product categories (Name, Description)`
+- `Manage products (Name, Category, Description, Price, Images, CreatedDate, UpdatedDate)`
+- `View customers`
+
+::: tip
+
+<p align="justify">
+The project should apply as many techniques of ASP.NET MVC Core as possible. For example: TagHelpers, Razor Pages, ViewComponents and have Unit Test. The Unit Test do not need to have a high coverage number but should demonstrate the ability to write unit test for common components: Controllers, ViewComponents, Services …
+</p>
+
+:::
+
+## Technical Stack
+
+- [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.
+- [Next.js 14.0](https://nextjs.org/): A React framework that enables functionality such as server-side rendering and generating static websites for React-based web applications.
+- [Duende IdentityServer 7.0](https://duendesoftware.com/products/identityserver): An authentication server that provides authentication and authorization services for the application.
+- [Redis](https://redis.io/): An open-source, in-memory data structure store used as a database, cache, and message broker.
+- [Postgres](https://www.postgresql.org/): A powerful, open-source object-relational database system.
+- [Aspire](https://learn.microsoft.com/dotnet/aspire): An opinionated, cloud ready stack for building observable, production ready, distributed applications.
+- [OpenTelemetry](https://opentelemetry.io/): An observability framework for cloud-native software.
+- [NUKE](https://nuke.build/): A cross-platform build automation system with C# DSL.