Consolidate README

Author: jason301c

README.md

@@ -1,14 +1,22 @@
-# MAC Job Board
+# MPLOY - MAC Job Board
 
 Hey there! 👋
 
 This is a modern, intelligent job board platform that automatically aggregates job listings, providing users with a streamlined experience to search, filter, and discover relevant opportunities. The platform updates daily with fresh listings through our smart AI robots.
 
 ## Features 🚀
+
 - Jobs update automatically every single day from various sources (automatically deduplicated)
 - We use AI to help fix, sort and summarise the listings
-- You can filter for exactly what you want (e.g. Big Tech Intern Roles for Interational students)
+- You can filter for exactly what you want (e.g. Big Tech Intern Roles for International students)
 - Works perfectly on phone or laptop
+- Server-side rendering (where possible) with Next.js 15 App Router
+- Multiple filters can be applied at once, including text search
+- Desktop/mobile responsive UI: list/details on desktop, modal on mobile
+- State persists in URL: search, filters, pagination (`/jobs?q=dev&location=sydney&page=2`)
+- Direct job links supported (`/jobs/[id]`)
+- Parallel data fetching for faster loads
+- Real-time job search with debouncing
 
 ## Frontend
 
@@ -18,6 +26,31 @@ This is a modern, intelligent job board platform that automatically aggregates j
 - Mantine UI: For consistent, accessible UI components
 - Tailwind CSS: For utility-first styling and responsive design
 
+### Key Patterns
+
+- **State Management**: Start with props; use custom hooks for reusable logic; Context for global state (e.g., job filters).
+- **Data Flow**: URL as source of truth for filters/search; debounced API calls; prefetching for pagination.
+- **Components**: Keep thin (50-150 lines); use layouts for shared UI; mark client components with "use client".
+- **Features Used**: Intercepting routes for modals; Suspense for loading; Error boundaries; useMemo/useRef for optimization.
+
+### Structure
+
+```
+src/
+├── app/
+│   ├── jobs/          # Main jobs route with filters, listing, details
+│   │   ├── [id]/      # Dynamic job page
+│   │   └── error.tsx  # Job-specific error handling
+│   ├── layout.tsx     # Root layout with providers
+│   └── page.tsx       # Home (redirects to /jobs)
+├── components/
+│   ├── jobs/          # Job cards, lists, details, filters
+│   └── layout/        # Nav, logo, search bar
+├── context/
+│   └── filter/        # Filter state provider
+└── lib/               # Utils, theme
+```
+
 ## Backend
 
 - Server Actions: Answers search and feedback requests
@@ -27,35 +60,38 @@ This is a modern, intelligent job board platform that automatically aggregates j
 ## Getting Started
 
 ### Prerequisites
+
 - Node.js 20+
 - Java 17
 - Go 1.21+
 - Docker & Docker Compose
 - Redis
 
 ### Local Development
-```bash
-# Start all services
-docker compose -f docker-compose.dev.yml up
-# Alternative if Make is installed
-make dev
 
-# Frontend only
+```bash
 cd frontend
 npm install
 npm run dev
+```
 
-# Backend only
-cd backend
-./gradlew bootRun
+## Environment Variables
+
+```
+MONGODB_URI=
+MONGODB_DATABASE=default
+MONGODB_COLLECTION=listings
+
+NODE_ENV=development
 ```
 
 ## Development Guidelines
 
 ### Git Workflow
 
 #### Branch Structure
-- `main` - Production branch
+
+- `production` - Production branch
 - `dev` - Development branch
 - Feature branches follow the pattern:
   ```
@@ -64,6 +100,19 @@ cd backend
   - backend/edwn/redis-caching
   - frontend/sarah/job-filters
   ```
-  
+
+### Coding Conventions
+
+- Use kebab-case for files (e.g., `product-card.ts`); camelCase for hooks (e.g., `useCustomHook`).
+- Group related components in feature directories (e.g., `components/jobs/filters/`).
+- Prioritize server components; use "use client" only when needed.
+- Build with scalability and observability in mind (e.g., structured logging with Pino).
+
+## Deployment (Development and Production)
+
+- We are deployed on Azure Container Apps via Github Actions.
+- GitHub Actions -> builds containers -> Azure Containers Registry -> Azure Container Apps.
+
 ## License
-This project is licensed under the MIT License.
+
+This project is licensed under the MIT License.