Skip to content

Commit be6839c

Browse files
authored
Create README.md (#5) (#6)
1 parent 2f66acb commit be6839c

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# MPloy Job Board
2+
3+
A modern job board application built with Next.js, Spring Boot, and Go, designed to help students find internships and job opportunities.
4+
5+
### Frontend
6+
- Next.js 15 with App Router
7+
- React 19
8+
- TypeScript
9+
- Mantine UI
10+
- Tailwind CSS
11+
12+
### Backend
13+
- Spring Boot (Kotlin)
14+
- Redis for caching
15+
- RESTful APIs
16+
17+
## Getting Started
18+
19+
### Prerequisites
20+
- Node.js 20+
21+
- Java 17
22+
- Go 1.21+
23+
- Docker & Docker Compose
24+
- Redis
25+
26+
### Local Development
27+
```bash
28+
# Start all services
29+
docker compose -f docker-compose.dev.yml up
30+
# Alternative if Make is installed
31+
make dev
32+
33+
# Frontend only
34+
cd frontend
35+
npm install
36+
npm run dev
37+
38+
# Backend only
39+
cd backend
40+
./gradlew bootRun
41+
```
42+
43+
## Development Guidelines
44+
45+
### Git Workflow
46+
47+
#### Branch Structure
48+
- `main` - Production branch
49+
- `dev` - Development branch
50+
- Feature branches follow the pattern:
51+
```
52+
<component>/<developer>/<feature-name>
53+
Examples:
54+
- backend/edwn/redis-caching
55+
- frontend/sarah/job-filters
56+
- fullstack/alex/docker-setup
57+
```
58+
59+
## License
60+
This project is licensed under the MIT License.

0 commit comments

Comments
 (0)