product-list/TomWinskell

.dockerignore

@@ -0,0 +1,41 @@
+# Node
+node_modules
+npm-debug.log
+yarn-debug.log
+yarn-error.log
+.pnpm-store
+dist
+build
+.cache
+
+# Env
+.env
+.env.*
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Git
+.git
+.gitignore
+
+# Editor/IDE
+.vscode
+.idea
+
+# Docker
+Dockerfile*
+.dockerignore
+
+# Test & coverage
+coverage
+*.test.*
+*.spec.*
+jest.config.*
+cypress/
+playwright/
+
+# Monorepo tooling
+turbo
+*.tsbuildinfo

.gitignore

@@ -0,0 +1,30 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules/
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+.yalc/
+yalc.lock
+
+# Environment variables
+.env

.npmrc

@@ -0,0 +1 @@
+package-lock=false

README.md

@@ -1,6 +1,66 @@
-## Product List
+# Product List Monorepo
 
+A full-stack product management application with a React frontend and Express.js API backend.
 
-This project has been created by a student at Parsity, an online software engineering course. The work in this repository is wholly of the student based on a sample starter project that can be accessed by looking at the repository that this project forks.
+## Structure
 
-If you have any questions about this project or the program in general, visit [parsity.io](https://parsity.io/) or email hello@parsity.io.
+```
+apps/
+├── web/         # React + Redux Toolkit frontend
+├── api/         # Express.js + MongoDB backend
+```
+
+## Quick Start
+
+### Prerequisites
+
+- [Docker Desktop](https://docs.docker.com/get-started/get-docker/)
+
+### Docker Setup
+
+```bash
+# Build and start all services
+yarn docker:build
+
+# Generate seed data (run after build)
+curl http://localhost:3000/generate
+```
+
+**Access points:**
+- Web app: http://localhost:8080
+- API docs: http://localhost:3000/docs
+
+### Development
+
+```bash
+# Individual services
+yarn docker:web:build && yarn docker:web    # Web only
+yarn docker:api:build && yarn docker:api    # API only
+
+# Local development (requires MongoDB)
+yarn dev
+```
+
+## Tech Stack
+
+**Frontend (web):**
+
+- React 19 + Redux Toolkit
+- Vite + TypeScript
+- Tailwind CSS + Flowbite React
+
+**Backend (api):**
+
+- Express.js + TypeScript
+- MongoDB + Mongoose
+- TSOA (auto-generated routes/docs)
+
+## Features
+
+- Product browsing with search, filtering, and pagination
+- Product reviews and ratings
+- Dark/light mode toggle
+- Responsive design
+- Auto-generated API documentation
+
+For detailed setup and development information, see the README files in each app directory.

apps/api/.env.example

@@ -0,0 +1,2 @@
+# Uncomment if running API in docker but mongodb locally on macOS/Windows
+# MONGODB=mongodb://host.docker.internal:27017/products

apps/api/Dockerfile

@@ -0,0 +1,28 @@
+# Build stage
+FROM node:18-alpine AS build
+
+WORKDIR /app
+
+# Copy workspace root files (relative to build context)
+# Copy API workspace package.json
+COPY package.json yarn.lock ./
+COPY apps/api/package.json ./apps/api/
+
+# Install only the API workspace (and its deps)
+RUN yarn install
+
+# Copy all files
+COPY apps/api ./apps/api
+
+# Build the specific workspace
+RUN yarn workspace api build
+
+# Production stage
+FROM node:18-alpine
+WORKDIR /app
+# Copy built application
+COPY --from=build /app/apps/api/build ./build
+# Copy node_modules
+COPY --from=build /app/node_modules ./node_modules
+EXPOSE 3000
+CMD ["node", "build/src/server.js"]

apps/api/README.md

@@ -0,0 +1,128 @@
+# Product List API
+
+A RESTful API for managing products and reviews, built with Express.js, TypeScript, and MongoDB. This API provides endpoints for product management, review system, and data generation using TSOA for automatic route generation and OpenAPI documentation.
+
+## Features
+
+- **Product Management**: CRUD operations for products
+- **Review System**: Create and manage product reviews
+- **Data Generation**: Generate sample products and reviews using Faker.js
+- **Auto-generated Documentation**: Swagger/OpenAPI documentation
+- **Type Safety**: Full TypeScript implementation with Zod validation
+- **CORS Support**: Cross-origin resource sharing enabled
+
+## Tech Stack
+
+- **Node.js** - Runtime environment
+- **Express.js** - Web framework
+- **TypeScript** - Type safety
+- **MongoDB** - Database with Mongoose ODM
+- **TSOA** - Auto-generated routes and OpenAPI specs
+- **Faker.js** - Sample data generation
+- **Swagger UI** - API documentation interface
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js (v18 or higher)
+- MongoDB (running locally or connection string)
+- npm or yarn
+
+### Installation
+
+```bash
+# Install dependencies
+npm install
+
+# Start development server with auto-reload
+npm run dev
+
+# Build for production
+npm run build
+
+# Start production server
+npm start
+```
+
+### Database Setup
+
+Ensure MongoDB is running locally on the default port (27017).
+
+## API Documentation
+
+Interactive API documentation is available at:
+```
+http://localhost:3000/docs
+```
+
+## API Endpoints
+
+### Products
+
+| Method | Endpoint | Description | Query Parameters |
+|--------|----------|-------------|------------------|
+| GET | `/products` | Get all products | `page`, `limit`, `category`, `price`, `query` |
+| GET | `/products/{id}` | Get product by ID | - |
+| POST | `/products` | Create new product | - |
+| DELETE | `/products/{id}` | Delete product | - |
+
+**Product Query Parameters:**
+- `page` - Page number for pagination
+- `limit` - Number of items per page
+- `category` - Filter by product category
+- `price` - Sort by price (`highest` or `lowest`)
+- `query` - Search products by name
+
+**Product Schema:**
+```json
+{
+  "name": "string",
+  "category": "string", 
+  "price": "number",
+  "image": "string (URL)"
+}
+```
+
+### Reviews
+
+| Method | Endpoint | Description | Query Parameters |
+|--------|----------|-------------|------------------|
+| GET | `/reviews/{productId}` | Get reviews for product | `page`, `limit` |
+| POST | `/reviews` | Create new review | - |
+| DELETE | `/reviews/{id}` | Delete review | - |
+
+**Review Schema:**
+```json
+{
+  "text": "string",
+  "rating": "number (1-5)",
+  "productId": "string"
+}
+```
+
+### Data Generation
+
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| GET | `/generate` | Generate sample products and reviews | 
+
+### Project Structure
+
+```
+src/
+├── errors/           # Error handling and types
+├── generate/         # Data generation endpoints
+├── products/         # Product-related endpoints
+│   ├── productModel.ts
+│   ├── productsController.ts
+│   ├── productsService.ts
+│   └── productTypes.ts
+├── reviews/          # Review-related endpoints
+│   ├── reviewModel.ts
+│   ├── reviewsController.ts
+│   ├── reviewsService.ts
+│   └── reviewTypes.ts
+├── app.ts           # Express app configuration
+└── server.ts        # Server entry point
+```