From 8f53a022c8438b26a05f8b57999552ce3b84b798 Mon Sep 17 00:00:00 2001
From: ed <edwinli123456@gmail.com>
Date: Thu, 23 Jan 2025 01:46:26 +1100
Subject: [PATCH] Create README.md (#5)

---
 README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c5fc1f0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,60 @@
+# MPloy Job Board
+
+A modern job board application built with Next.js, Spring Boot, and Go, designed to help students find internships and job opportunities.
+
+### Frontend
+- Next.js 15 with App Router
+- React 19
+- TypeScript
+- Mantine UI
+- Tailwind CSS
+
+### Backend
+- Spring Boot (Kotlin)
+- Redis for caching
+- RESTful APIs
+
+## 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
+cd frontend
+npm install
+npm run dev
+
+# Backend only
+cd backend
+./gradlew bootRun
+```
+
+## Development Guidelines
+
+### Git Workflow
+
+#### Branch Structure
+- `main` - Production branch
+- `dev` - Development branch
+- Feature branches follow the pattern:
+  ```
+  <component>/<developer>/<feature-name>
+  Examples:
+  - backend/edwn/redis-caching
+  - frontend/sarah/job-filters
+  - fullstack/alex/docker-setup
+  ```
+  
+## License
+This project is licensed under the MIT License.
\ No newline at end of file