Skip to content

Latest commit

 

History

History
69 lines (53 loc) · 1.99 KB

README.md

File metadata and controls

69 lines (53 loc) · 1.99 KB

Readly

A Book Social Network for sharing, borrowing, and returning books. Built with Spring Boot and Angular, featuring user-friendly interfaces, file upload for book covers, email verification, and secure account management.

Table of Contents

Installation

To install and run this project, you will need to have Java, Maven, Node.js, and Angular CLI installed on your machine.

  1. Clone the repository: git clone https://github.com/MohamedBoukthir/readly.git
  2. Navigate into the project directory: cd readly
  3. Install the dependencies:
    • For the backend: mvn install
    • For the frontend: cd frontend && npm install
  4. Run the project:
    • For the backend: mvn spring-boot:run
    • For the frontend: ng serve -o

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
  • GitHub Actions
  • Keycloak

Frontend

  • Angular
  • Component-Based Architecture
  • Lazy Loading
  • Authentication Guard
  • OpenAPI Generator for Angular
  • Tailwind CSS

API Endpoints

The backend provides the following API endpoints:

  • Authentication

auth

  • Books

book

  • Feedback

feedback

Contributing

Contributions are welcome. Please feel free to submit a pull request or open an issue.

Connect with me

You can connect with me on: