feat(order): implement order api and workflow (#7)

* add ngrock to expose a webhook for order service

* code review

* fix(order): add processing payment child workflow for creating orders

* fix vscode debugging and add payment lib

* add nestjs app for product management

* implement endpoint for loading products

* fix issue creating orders with stripe

* fix workflow steps for reporting order failures

* fix payment processing workflow

* code review

Author: jdnichollsc

.env.example

@@ -15,15 +15,29 @@ DATABASE_URL="postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@db:${POSTGRES_P
 
 # SERVICES SETTINGS
 NODE_ENV=development
-AUTH_PORT=9095
-ORDER_PORT=9096
+AUTH_PORT=8081
+ORDER_PORT=8082
+PRODUCT_PORT=8083
 SENDGRID_API_KEY=SG.your_sendgrid_api_key
 # REMEMBER TO USE A VALID SENDER EMAIL, more info: https://app.sendgrid.com/settings/sender_auth/senders
 EMAIL_FROM=[email protected]
 EMAIL_FROM_NAME=ProjectX Team
 
+# PAYMENT SETTINGS
+# You can find your secret key in your Stripe account
+STRIPE_PUBLISHABLE_KEY=pk_test_your_stripe_publishable_key
+STRIPE_SECRET_KEY=sk_test_your_stripe_secret_key
+# If you are testing your webhook locally with the Stripe CLI you
+# can find the endpoint's secret by running `stripe listen`
+# Otherwise, find your endpoint's secret in your webhook settings in the Developer Dashboard
+STRIPE_WEBHOOK_SECRET=whsec_your_stripe_webhook_signing_secret
+
+# DEVELOPMENT ONLY
+NGROK_AUTHTOKEN=your_ngrok_auth_token
+
 # WEB SETTINGS
 SESSION_SECRET=your_secret_key_for_sessions
 AUTH_API_URL="http://localhost:${AUTH_PORT}"
 ORDER_API_URL="http://localhost:${ORDER_PORT}"
+PRODUCT_API_URL="http://localhost:${PRODUCT_PORT}"
 JWT_SECRET=your_secret_key_for_jwt

.vscode/launch.json

@@ -3,7 +3,6 @@
   // Hover to view descriptions of existing attributes.
   // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
-  "resolveSourceMapLocations": ["${workspaceFolder}/**", "!**/node_modules/**"],
   "configurations": [
     {
       "name": "Web",
@@ -16,6 +15,81 @@
       "console": "internalConsole",
       "cwd": "${workspaceFolder}",
       "envFile": "${workspaceFolder}/.env"
+    },
+    {
+      "name": "Debug Auth Service",
+      "type": "node",
+      "request": "attach",
+      "port": 9229,
+      "restart": true,
+      "sourceMaps": true,
+      "remoteRoot": "/app",
+      "localRoot": "${workspaceFolder}",
+      "outFiles": [
+        "${workspaceFolder}/dist/apps/auth/**/*.js",
+        "${workspaceFolder}/dist/libs/**/*.js"
+      ],
+      "resolveSourceMapLocations": [
+        "${workspaceFolder}/**",
+        "!**/node_modules/**"
+      ],
+      "skipFiles": ["<node_internals>/**"],
+      "trace": true,
+      "sourceMapPathOverrides": {
+        "webpack:///./~/*": "${workspaceFolder}/node_modules/*",
+        "webpack:///./*": "${workspaceFolder}/*",
+        "webpack:///*": "*"
+      }
+    },
+    {
+      "name": "Debug Order Service",
+      "type": "node",
+      "request": "attach",
+      "port": 9230,
+      "restart": true,
+      "sourceMaps": true,
+      "remoteRoot": "/app",
+      "localRoot": "${workspaceFolder}",
+      "outFiles": [
+        "${workspaceFolder}/dist/apps/order/**/*.js",
+        "${workspaceFolder}/dist/libs/**/*.js"
+      ],
+      "resolveSourceMapLocations": [
+        "${workspaceFolder}/**",
+        "!**/node_modules/**"
+      ],
+      "skipFiles": ["<node_internals>/**"],
+      "trace": true,
+      "sourceMapPathOverrides": {
+        "webpack:///./~/*": "${workspaceFolder}/node_modules/*",
+        "webpack:///./*": "${workspaceFolder}/*",
+        "webpack:///*": "*"
+      }
+    },
+    {
+      "name": "Debug Product Service",
+      "type": "node",
+      "request": "attach",
+      "port": 9231,
+      "restart": true,
+      "sourceMaps": true,
+      "remoteRoot": "/app",
+      "localRoot": "${workspaceFolder}",
+      "outFiles": [
+        "${workspaceFolder}/dist/apps/product/**/*.js",
+        "${workspaceFolder}/dist/libs/**/*.js"
+      ],
+      "resolveSourceMapLocations": [
+        "${workspaceFolder}/**",
+        "!**/node_modules/**"
+      ],
+      "skipFiles": ["<node_internals>/**"],
+      "trace": true,
+      "sourceMapPathOverrides": {
+        "webpack:///./~/*": "${workspaceFolder}/node_modules/*",
+        "webpack:///./*": "${workspaceFolder}/*",
+        "webpack:///*": "*"
+      }
     }
   ]
 }

README.md

@@ -8,11 +8,12 @@
   <img width="100px" alt="Temporal for Durable Executions" src="https://avatars.githubusercontent.com/u/56493103?s=200&v=4">
 </p>
 
-> **ProjectX** is a comprehensive full-stack template designed to simplify the development of scalable and resilient applications using **React** and **Temporal**. By integrating Temporal’s advanced workflow orchestration with React’s dynamic frontend framework, ProjectX enables developers to build applications with durable executions and seamless communication between services.
+> **ProjectX** is a comprehensive full-stack template designed to simplify the development of scalable and resilient applications using **React** and **Temporal**. By integrating Temporal's advanced workflow orchestration with React's dynamic frontend framework, ProjectX enables developers to build applications with durable executions and seamless communication between services.
 
 ## Notable Links 🤓
 
 - [Get started with Temporal and TypeScript](https://github.com/temporalio/sdk-typescript)
+- [Workflow Messages - TypeScript SDK](https://docs.temporal.io/develop/typescript/message-passing)
 
 ### Public Courses
 
@@ -50,45 +51,47 @@ Additionally, workflows support scheduled and time-based executions with configu
 
 •	**Batch Processing:** Handling large-scale batch jobs with retry mechanisms and progress monitoring.
 
-## Setting Up 🛠️
+## Getting Started 🚀
 
-### Requirements 🧰
+### Prerequisites 🧰
 
+- [Docker Compose](https://docs.docker.com/compose/install)
 - [Node.js LTS Version](https://nodejs.org)
 - [Git](https://git-scm.com/downloads)
-- [Docker Compose](https://docs.docker.com/compose/install)
 - Code editor: 
   - [VSCode](https://code.visualstudio.com/)
   - [Cursor](https://www.cursor.com/)
 
-### From Linux/Mac 
+### Quick Setup 🛠️
 
-- Install Homebrew
-- Install tools using Homebrew:
-```sh
-brew install node
-brew install git
-brew install docker-compose
-npm add --global nx@latest
+1. **Clone and Setup Environment:**
+```bash
+git clone https://github.com/proyecto26/projectx.git
+cd projectx
+cp .env.example .env
 ```
 
-### Documentation 📚
-
-- **FrontEnd:**
-Commands used to create the project and frontend structure (Nx, RemixJS, etc) [here](./docs/frontend/README.md).
-
-- **BackEnd:**
-Commands used to create the services (NestJS, Temporal, etc) [here](./docs/backend/README.md).
+2. **Start Development Environment:**
+```bash
+# Build and start all services (db, temporal, backend services)
+docker-compose up -d
 
-## Usage 🏃
+# View service logs
+docker-compose logs -f [service]
 
-### Monorepo
+# Start web application
+npm install
+npm run dev:web
+```
 
-Instructions to use Nx CLI [here](./docs/NX_README.md).
+### Documentation 📚
 
-For more information on using Nx, refer to the [Nx documentation](https://nx.dev/getting-started/intro).
+For detailed information about the project, please refer to:
+- [Architecture Overview](./docs/architecture/README.md)
+- [Frontend Guide](./docs/frontend/README.md)
+- [Backend Guide](./docs/backend/README.md)
 
-### Project Structure Overview
+## Project Structure Overview
 
 <img width="1643" alt="image" src="https://github.com/user-attachments/assets/82e99efc-640d-4ba4-a485-c92c0184f473">
 
@@ -113,6 +116,10 @@ For more information on using Nx, refer to the [Nx documentation](https://nx.dev
   - **Purpose**: Manages order processing, checkout, and payment handling.
   - **Key Features**: Cart management, order tracking, and payment integration.
 
+- **apps/product**: 
+  - **Purpose**: Manages product catalog and inventory.
+  - **Key Features**: Product listing, details, and inventory management.
+
 - **apps/web**: 
   - **Purpose**: The main web application interface.
   - **Key Features**: User interaction with the system.
@@ -152,65 +159,76 @@ For more information on using Nx, refer to the [Nx documentation](https://nx.dev
 ```
 </details>
 
-### Run the web app
 
-```sh
-npm run dev:web
-```
 
-### Run the ui lib (See all the UI components)
 
-```sh
-npm run storybook
-```
+> [!TIP]
+> View the Database diagram [here](./libs/backend/db/README.md).
 
-### Run services with Docker Compose
 
-- Build the images:
-```sh
-docker-compose build --no-cache
-```
 
-- Run the services:
-```sh
-docker-compose up -d
-```
-
-- Delete the services: 
-```sh
-docker-compose down --volumes
-```
 
-## Explore the project 👀
+## Development Tools 🔧
 
-```sh
+### Monorepo Management
+```bash
+# View project structure
 npx nx show projects
 npx nx graph
-```
-
-View the Database diagram [here](./libs/backend/db/README.md).
 
-Do you want to change the path of a project to decide your own organization? No problem:
-```sh
+# Move project location
 npx nx g @nx/workspace:move --project core libs/backend/common
 ```
 
-## Update project ⚡
+### UI Development
+```bash
+# Run Storybook
+npm run storybook
+```
 
-```sh
+### Project Updates
+```bash
 npx nx migrate latest
 npx nx migrate --run-migrations
 ```
 
-## Docker 🚢
+## Docker Configuration 🐳
 
-- Images:
-  * https://registry.hub.docker.com/r/postgis/postgis/
-  * https://registry.hub.docker.com/r/temporalio/auto-setup
-  * https://registry.hub.docker.com/r/temporalio/admin-tools
-  * https://registry.hub.docker.com/r/temporalio/ui
+Services defined in [docker-compose.yml](./docker-compose.yml):
+- PostgreSQL with PostGIS
+- Temporal server and UI
+- Auth, Order, and Product services
 
-All the images needed to run this project in development are listed in the [docker-compose.yml](./docker-compose.yml) file.
+### Common Commands
+```bash
+# Build fresh images
+docker-compose build --no-cache
+
+# Start services
+docker-compose up -d
+
+# Remove services and volumes
+docker-compose down --volumes
+```
+
+## Payment Providers
+
+- Stripe:
+  - [Webhooks](https://docs.stripe.com/webhooks?lang=node)
+  - [Stripe Webhook integration](https://docs.stripe.com/api/webhook_endpoints)
+  - [Stripe Checkout](https://docs.stripe.com/payments/checkout)
+  - [Webhooks Dashboard](https://dashboard.stripe.com/test/workbench/webhooks)
+  - [Automatic fulfillment Orders](https://docs.stripe.com/checkout/fulfillment)
+  - [Interactive webhook endpoint builder](https://docs.stripe.com/webhooks/quickstart)
+  - [Trigger webhook events with the Stripe CLI](https://docs.stripe.com/stripe-cli/triggers)
+  - [Testing cards](https://docs.stripe.com/testing#cards)
+- Stripe commands for testing webhooks:
+```bash
+brew install stripe/stripe-cli/stripe
+stripe login --api-key ...
+stripe trigger payment_intent.succeeded
+stripe listen --forward-to localhost:8081/order/webhook
+```
 
 ## Supporting 🍻
 I believe in Unicorns 🦄

apps/auth/project.json

@@ -5,10 +5,35 @@
   "projectType": "application",
   "tags": [],
   "targets": {
+    "build": {
+      "executor": "@nx/webpack:webpack",
+      "outputs": ["{options.outputPath}"],
+      "defaultConfiguration": "production",
+      "options": {
+        "target": "node",
+        "compiler": "tsc",
+        "outputPath": "dist/apps/auth",
+        "main": "apps/auth/src/main.ts",
+        "tsConfig": "apps/auth/tsconfig.app.json",
+        "assets": [
+          "apps/auth/src/assets",
+          "apps/auth/src/workflows"
+        ],
+        "isolatedConfig": true,
+        "webpackConfig": "apps/auth/webpack.config.js"
+      },
+      "configurations": {
+        "development": {
+          "mode": "development"
+        },
+        "production": {
+          "mode": "production"
+        }
+      }
+    },
     "serve": {
       "executor": "@nx/js:node",
       "defaultConfiguration": "development",
-      "dependsOn": ["build"],
       "options": {
         "buildTarget": "auth:build",
         "runBuildTargetDependencies": false

apps/auth/src/app/app.controller.ts

@@ -15,6 +15,11 @@ import { AppService } from './app.service';
 export class AppController {
   constructor(private readonly appService: AppService) {}
 
+  /**
+   * Endpoint to initiate the login process by sending a verification email.
+   * @param body AuthLoginDto containing the user's email.
+   * @returns A message indicating the email was sent.
+   */
   @ApiOperation({
     summary: 'Login with email',
     description: 'This endpoint allow a user to login with email',
@@ -28,9 +33,14 @@ export class AppController {
   @Post('login')
   @HttpCode(HttpStatus.CREATED)
   login(@Body() body: AuthLoginDto) {
-    return this.appService.sendLoginEmail(body);
+    return this.appService.login(body);
   }
 
+  /**
+   * Endpoint to verify the login code and authenticate the user.
+   * @param body AuthVerifyDto containing the user's email and verification code.
+   * @returns AuthResponseDto containing the access token and user information.
+   */
   @ApiOperation({
     summary: 'Verify login code',
     description: 'This endpoint allow a user to verify the login code',