A full-stack community platform for students and developers to share interview experiences, career advice, and study notes.
- Java 21
- Spring Boot 3
- Spring Security + JWT Authentication
- JPA / Hibernate
- MySQL
- React 18 (Create React App)
- React Router v6
- Axios
- CSS Modules
- ๐ User registration and login with JWT
- ๐ Create, view, and delete career posts
- ๐ Upload and download study notes (PDF, DOC, PPT, etc.)
- ๐ Upvote and downvote posts and notes
- ๐ฌ Comments with threaded replies on posts and notes
- ๐๏ธ Filter posts by category (Interview Experience, Career Advice, General)
- ๐ Search notes by title or subject
- ๐ Paginated feed and notes list
readit/
โโโ readit-backend/ # Spring Boot backend
โ โโโ src/main/java/com/readit/
โ โโโ config/ # SecurityConfig
โ โโโ controller/ # REST controllers
โ โโโ dto/
โ โ โโโ request/ # Request DTOs
โ โ โโโ response/ # Response DTOs
โ โโโ entity/ # JPA entities
โ โโโ exception/ # Global exception handling
โ โโโ repository/ # Spring Data JPA repositories
โ โโโ security/ # JWT filter, JwtUtil, UserDetailsService
โ โโโ service/ # Business logic
โ
โโโ readit-frontend/
โโโ frontend/ # React app
โโโ src/
โโโ api/ # Axios instance
โโโ context/ # AuthContext (global auth state)
โโโ components/ # Reusable components
โ โโโ Navbar/
โ โโโ PostCard/
โ โโโ NoteCard/
โ โโโ VoteButtons/
โ โโโ CommentSection/
โโโ pages/ # Page components
โโโ Home/
โโโ Login/
โโโ Register/
โโโ CreatePost/
โโโ PostDetail/
โโโ Notes/
โโโ UploadNote/
โโโ NoteDetail/
- Java 21
- Maven
- MySQL
CREATE DATABASE readit_db;spring.datasource.url=jdbc:mysql://localhost:3306/readit_db
spring.datasource.username=your_mysql_username
spring.datasource.password=your_mysql_password
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
app.jwt.secret=your_super_secret_key_minimum_32_characters
app.jwt.expiration=86400000
spring.servlet.multipart.max-file-size=10MB
spring.servlet.multipart.max-request-size=10MBcd readit-backend
./mvnw spring-boot:runBackend starts at: http://localhost:8080
- Node.js 18+
- npm
cd readit-frontend/frontend
npm installnpm startFrontend starts at: http://localhost:3000
โ ๏ธ Make sure the backend is running before starting the frontend.
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/auth/register |
Register a new user |
| POST | /api/auth/login |
Login and get JWT token |
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/posts |
Get paginated feed |
| GET | /api/posts/{id} |
Get single post |
| GET | /api/posts/category/{category} |
Filter by category |
| POST | /api/posts |
Create a post |
| PUT | /api/posts/{id} |
Update a post (owner only) |
| DELETE | /api/posts/{id} |
Delete a post (owner only) |
| POST | /api/posts/{id}/vote |
Upvote or downvote |
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/notes |
Get paginated notes list |
| GET | /api/notes/{id} |
Get single note |
| POST | /api/notes |
Upload a note (multipart/form-data) |
| DELETE | /api/notes/{id} |
Delete a note (owner only) |
| POST | /api/notes/{id}/vote |
Upvote or downvote |
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/posts/{id}/comments |
Get comments for a post |
| POST | /api/posts/{id}/comments |
Add comment to a post |
| GET | /api/notes/{id}/comments |
Get comments for a note |
| POST | /api/notes/{id}/comments |
Add comment to a note |
| DELETE | /api/comments/{id} |
Delete a comment (owner only) |
INTERVIEW_EXPERIENCE
CAREER_ADVICE
GENERAL
UPVOTE
DOWNVOTE
All protected endpoints require a Bearer token in the request header:
Authorization: Bearer <your_jwt_token>
The token is returned on login and register, stored in localStorage, and automatically attached to every request via the Axios interceptor.
1. Register
POST http://localhost:8080/api/auth/register
{
"username": "testuser",
"email": "test@example.com",
"password": "123456"
}2. Login
POST http://localhost:8080/api/auth/login
{
"email": "test@example.com",
"password": "123456"
}3. Create Post
POST http://localhost:8080/api/posts
Authorization: Bearer <token>
{
"title": "My Google Interview Experience",
"content": "Here is how it went...",
"category": "INTERVIEW_EXPERIENCE"
}4. Upload Note (form-data)
POST http://localhost:8080/api/notes
Authorization: Bearer <token>
title โ My DSA Notes
subject โ Data Structures
descriptionโ Complete revision notes
file โ [select file]
| Table | Description |
|---|---|
users |
Stores user accounts |
posts |
Career posts and interview experiences |
notes |
Uploaded study notes with file info |
comments |
Threaded comments on posts and notes |
votes |
Upvotes/downvotes on posts and notes |
| Route | Page | Auth Required |
|---|---|---|
/login |
Login page | โ |
/register |
Register page | โ |
/ |
Home feed | โ |
/posts/create |
Create post | โ |
/posts/:id |
Post detail + comments | โ |
/notes |
Notes list | โ |
/notes/upload |
Upload note | โ |
/notes/:id |
Note detail + comments | โ |
- Excalidraw collaborative whiteboard integration
- User profile pages
- Edit posts and notes
- Bookmark posts and notes
- Email verification
- File preview (PDF viewer in browser)
- Dark mode
Built with โค๏ธ using Spring Boot + React.