Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mehmedmaljoki/readit
All about books managment
https://github.com/mehmedmaljoki/readit
docker docker-compose dockerfile java react selenium selenium-java spring-boot spring-test-web spring-testcontainers test test-automation test-driven-development testcontainers testing testing-framework testing-library testing-tools tests
Last synced: 14 days ago
JSON representation
All about books managment
- Host: GitHub
- URL: https://github.com/mehmedmaljoki/readit
- Owner: mehmedmaljoki
- License: mit
- Created: 2024-11-20T22:04:38.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-13T14:53:06.000Z (21 days ago)
- Last Synced: 2024-12-13T16:23:39.991Z (21 days ago)
- Topics: docker, docker-compose, dockerfile, java, react, selenium, selenium-java, spring-boot, spring-test-web, spring-testcontainers, test, test-automation, test-driven-development, testcontainers, testing, testing-framework, testing-library, testing-tools, tests
- Language: Java
- Homepage:
- Size: 256 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Library and Book Management Application
[](/pom.xml)
[](/pom.xml)
## Introduction
**Manage Your Library Seamlessly:** A Comprehensive Platform for Book Enthusiasts.
This Library and Book Management Application is your one-stop solution for everything related to books and libraries. Whether you're managing a personal collection or a community library, this app allows you to:
- Add, update, and delete books.
- Write, read, and moderate reviews and comments.
- Participate in reading challenges and track your progress.
- View exhaustive statistics on your reading habits.
- Collaborate and engage with other book lovers.
**TL;DR:**
- Easily manage your book collection with a user-friendly interface.
- Track and share your thoughts through reviews and comments.
- Engage in personalized or group reading challenges.
- Explore analytics for insights into your reading trends.
- Secure, scalable, and modern backend and frontend technologies.
### Benefits
After using this application:
- You'll save time managing your books and library operations.
- Collaborate better with fellow readers or members of your library.
- Gain valuable insights into reading patterns through analytics.
- Experience a delightful, organized reading journey.
The application uses a state-of-the-art tech stack for reliability and scalability, providing a seamless experience for users. Whether you're a casual reader, librarian, or book enthusiast, this app caters to all.
---
## Application Architecture
To support its versatile features, the application uses the following tech stack:
- **Spring Boot** (Backend) for API development and database management.
- **React and TypeScript** (Frontend) for a smooth and interactive user experience.
- **PostgreSQL** for relational database management.
- **AWS S3** for storing book covers, images, and files.
- **Amazon SQS** for handling asynchronous processes like notifications and updates.
- **Keycloak** for secure authentication and role-based access control.
The architecture supports real-time updates, secure data handling, and a modular design to accommodate future enhancements.
---
## Key Features
- **Book Management:** Add, update, and organize your library effortlessly.
- **Reviews and Comments:** Share insights and engage in discussions with other readers.
- **Reading Challenges:** Create and join challenges to keep your reading habits exciting.
- **Statistics and Insights:** Understand your reading trends with daily, weekly, and yearly reports.
- **Social Features:** Connect and collaborate with friends, track shared challenges, and recommend books.
---
## Local Project Setup
### Requirements
**Mandatory Requirements:**
- **Java 21** or higher for backend development.
- **Docker Engine** and **Docker Compose** for setting up the local environment.
- **Node.js** and **npm/yarn** for frontend development.
- **PostgreSQL** for database setup.
Check your environment:
```bash
$ java -version
```
```bash
$ docker --version
```
```bash
$ node -v
```
```bash
$ npm -v
```
1. Ensure your Docker Engine is running.
2. Start required services with docker-compose up.
3. Run the backend:
- Navigate to the `backend` directory.
- ```bash
./mvnw spring-boot:run
```
4. Frontend will be started with backend
5. Access the application at `http://localhost:8080`.
6. Access Keycloak Admin (optional): `http://localhost:8888`.