https://github.com/sandesh300/book-social-network
Book Social Network
https://github.com/sandesh300/book-social-network
angular docker java postgresql spring-boot spring-data-jpa spring-security
Last synced: about 2 months ago
JSON representation
Book Social Network
- Host: GitHub
- URL: https://github.com/sandesh300/book-social-network
- Owner: sandesh300
- Created: 2024-10-08T17:14:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-02T16:23:30.000Z (over 1 year ago)
- Last Synced: 2025-10-31T04:41:28.243Z (5 months ago)
- Topics: angular, docker, java, postgresql, spring-boot, spring-data-jpa, spring-security
- Language: Java
- Homepage:
- Size: 1.11 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Book Social Network
Book Social Network is a full-stack application that enables users to manage their book collections and engage with a community of book enthusiasts. It offers features such as user registration, secure email validation, book management (including creation, updating, sharing, and archiving), book borrowing with checks for availability, book return functionality, and approval of book returns. The application ensures security using JWT tokens and adheres to best practices in REST API design. The backend is built with Spring Boot 3 and Spring Security 6, postgreSQL database, while the frontend is developed using Angular with Bootstrap for styling.
---
## Features
- **User Registration:** Users can register for a new account.
- **Email Validation:** Accounts are activated using secure email validation codes.
- **User Authentication:** Existing users can log in securely.
- **Book Management:** Users can create, update, share, and archive their books.
- **Book Borrowing:** Necessary checks to determine if a book can be borrowed.
- **Book Returning:** Users can return borrowed books.
- **Book Return Approval:** Functionality to approve book returns.
## Technologies Used
### Backend
- Spring Boot 3
- Spring Security 6
- JWT Token Authentication
- Spring Data JPA
- JSR-303 and Spring Validation
- OpenAPI and Swagger UI Documentation
- Docker
### Database
- PostgreSQL
### Frontend
- Angular
- Component-Based Architecture
- Lazy Loading
- Authentication Guard
- OpenAPI Generator for Angular
- Bootstrap
------
## Learning Objectives
By following this project,
- Designing a class diagram from business requirements
- Implementing a mono repo approach
- Securing an application using JWT tokens with Spring Security
- Registering users and validating accounts via email
- Utilizing inheritance with Spring Data JPA
- Implementing the service layer and handling application exceptions
- Object validation using JSR-303 and Spring Validation
- Handling custom exceptions
- Implementing pagination and REST API best practices
- Using Spring Profiles for environment-specific configurations
- Documenting APIs using OpenAPI and Swagger UI
- Implementing business requirements and handling business exceptions
- Dockerizing the infrastructure
- CI/CD pipeline & deployment
#### Class diagram
------
## API Endpoints
### OpenAPI Documentation
### **User Authentication**
1. **Register User**
- **Method**: `POST`
- **URL**: `http://localhost:8080/api/v1/auth/register`
- **Request Body**:
```json
{
"firstname": "sandesh",
"lastname": "bhujbal",
"email": "bhujbalsandesh52@gmail.com",
"password": "Password@123"
}
```
- **Response**: `202 Accepted`
2. **Activate Account**
- **Method**: `GET`
- **URL**: `http://localhost:8080/api/v1/auth/activate-account?token=`
- **Response**: `200 OK`
3. **Login User**
- **Method**: `POST`
- **URL**: `http://localhost:8080/api/v1/auth/authenticate`
- **Request Body**:
```json
{
"email": "bhujbalsandesh52@gmail.com",
"password": "Password@123"
}
```
- **Response**:
```json
{
"token": ""
}
```
- **Success Code**: `200 OK`
---
### **Book Management**
## Authorization
All endpoints require a JWT token.
Include the following header in all requests:
```http
Authorization: Bearer
```
---
## Endpoints
### 1. **Save Book**
- **Method**: `POST`
- **URL**: `http://localhost:8088/books`
- **Request Body**:
```json
{
"title": "Java Spring Boot Book",
"authorName": "James Gosling",
"isbn": "4512",
"synopsis": "Book about Java programming",
"shareable": true
}
```
- **Response Body**:
```json
{
"id": 58
}
```
- **Success Code**: `200 OK`
---
### 2. **Find Book by ID**
- **Method**: `GET`
- **URL**: `http://localhost:8088/books/{book-id}`
- **Response Body**:
```json
{
"id": 58,
"title": "Java Spring Boot Book",
"authorName": "James Gosling",
"isbn": "4512",
"synopsis": "Book about Java programming",
"rate": 4.5,
"bookCover": "http://example.com/cover.jpg",
"shareable": true,
"archived": false
}
```
- **Success Code**: `200 OK`
---
### 3. **Find All Books**
- **Method**: `GET`
- **URL**: `http://localhost:8088/books`
- **Query Params**:
- `page`: Page number (default: `0`)
- `size`: Number of items per page (default: `10`)
- **Response Body**:
```json
{
"content": [
{
"id": 58,
"title": "Java Spring Boot Book",
"authorName": "James Gosling",
"rate": 4.5
}
],
"number": 0,
"size": 10,
"totalElements": 1,
"totalPages": 1,
"first": true,
"last": true
}
```
- **Success Code**: `200 OK`
---
### 4. **Find Owner's Books**
- **Method**: `GET`
- **URL**: `http://localhost:8088/books/owner`
- **Query Params**: Same as Find All Books
- **Response Body**:
```json
{
"content": [
{
"id": 58,
"title": "Java Spring Boot Book",
"authorName": "James Gosling",
"rate": 4.5
}
],
"number": 0,
"size": 10,
"totalElements": 1,
"totalPages": 1,
"first": true,
"last": true
}
```
- **Success Code**: `200 OK`
---
### 5. **Find Borrowed Books**
- **Method**: `GET`
- **URL**: `http://localhost:8088/books/borrowed`
- **Query Params**: Same as Find All Books
- **Response Body**:
```json
{
"content": [
{
"bookId": 58,
"title": "Java Spring Boot Book",
"authorName": "James Gosling",
"isbn": "4512",
"borrowed": true,
"returned": false,
"returnApproved": false
}
],
"number": 0,
"size": 10,
"totalElements": 1,
"totalPages": 1,
"first": true,
"last": true
}
```
- **Success Code**: `200 OK`
---
### 6. **Find Returned Books**
- **Method**: `GET`
- **URL**: `http://localhost:8088/books/returned`
- **Query Params**: Same as Find All Books
- **Response Body**:
```json
{
"content": [
{
"bookId": 58,
"title": "Java Spring Boot Book",
"authorName": "James Gosling",
"isbn": "4512",
"borrowed": false,
"returned": true,
"returnApproved": true
}
],
"number": 0,
"size": 10,
"totalElements": 1,
"totalPages": 1,
"first": true,
"last": true
}
```
- **Success Code**: `200 OK`
---
### 7. **Update Book Shareable Status**
- **Method**: `PATCH`
- **URL**: `http://localhost:8088/books/shareble/{book-id}`
- **Response Body**:
```json
{
"id": 58,
"shareable": false
}
```
- **Success Code**: `200 OK`
---
### 8. **Update Book Archived Status**
- **Method**: `PATCH`
- **URL**: `http://localhost:8088/books/archived/{book-id}`
- **Response Body**:
```json
{
"id": 58,
"archived": true
}
```
- **Success Code**: `200 OK`
---
### 9. **Borrow Book**
- **Method**: `POST`
- **URL**: `http://localhost:8088/books/borrow/{book-id}`
- **Response Body**:
```json
{
"id": 1,
"bookId": 58,
"borrowedBy": "sandesh",
"borrowedAt": "2024-10-22T10:15:30Z"
}
```
- **Success Code**: `200 OK`
---
### 10. **Return Borrowed Book**
- **Method**: `PATCH`
- **URL**: `http://localhost:8088/books/borrow/return/{book-id}`
- **Response Body**:
```json
{
"id": 1,
"bookId": 58,
"returnedAt": "2024-10-22T10:16:36Z"
}
```
- **Success Code**: `200 OK`
---
### 11. **Approve Book Return**
- **Method**: `PATCH`
- **URL**: `http://localhost:8088/books/borrow/return/approve/{book-id}`
- **Response Body**:
```json
{
"id": 1,
"bookId": 58,
"returnApproved": true,
"approvedAt": "2024-10-22T10:23:35Z"
}
```
- **Success Code**: `200 OK`
---
### 12. **Upload Book Cover**
- **Method**: `POST`
- **URL**: `http://localhost:8088/books/cover/{book-id}`
- **Request**: Multipart file upload
- **Response Body**:
```json
{
"bookId": 58,
"coverUrl": "http://example.com/book-covers/58.jpg",
"uploadedAt": "2024-10-22T10:25:30Z"
}
```
- **Success Code**: `202 Accepted`
-----
## Setup Instructions
To set up the backend of the Book Social Network project, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/matnrocha/Book-Social-Network.git
```
2. Run the docker-compose file
```bash
docker-compose up -d
```
3. Navigate to the book-social-network directory:
```bash
cd book-social-network
```
4. Install dependencies (assuming Maven is installed):
```bash
mvn clean install
```
4. Run the application
```bash
java -jar target/book-network-0.0.1.jar
```
5. Access the API documentation using Swagger UI:
Open a web browser and go to `http://localhost:8088/api/v1/swagger-ui/index.html
6. Access MailDev to receive emails (token receiving):
Open a web browser and go to `http://localhost:1080/#/
---
### Login Page
### Register Page
### Email Verification code
### Book page
### Book Create Page
