https://github.com/evermake/book-review
Book Review Platform — final project for the Software Quality and Reliability course.
https://github.com/evermake/book-review
Last synced: 2 months ago
JSON representation
Book Review Platform — final project for the Software Quality and Reliability course.
- Host: GitHub
- URL: https://github.com/evermake/book-review
- Owner: evermake
- Created: 2024-04-17T18:34:02.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-30T10:51:05.000Z (about 1 year ago)
- Last Synced: 2025-01-27T07:30:43.691Z (4 months ago)
- Language: Python
- Homepage:
- Size: 460 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# The Book Review Platform
- [The Book Review Platform](#the-book-review-platform)
- [Project Description:](#project-description)
- [Key Features](#key-features)
- [Running the project](#running-the-project)
- [Style](#style)
- [Typechecking](#typechecking)
- [Configuration](#configuration)
- [Configuration options](#configuration-options)
The Book Review Platform (BRP) is a collaborative hub for literary enthusiasts.
## Project Description
BRP is a dynamic online platform designed to foster a vibrant community of book
lovers, where they can share their thoughts, discover new reads, and engage in
meaningful discussions. With a user-friendly interface and seamless integration
of external APIs, BRP offers an immersive experience for bibliophiles.
## Key Features
1. Book Reviews and Ratings:
- Users can write and publish detailed reviews for their favorite books.
Whether it’s a classic novel, a thrilling mystery, or a thought-provoking
non-fiction work, BRP provides a space to express opinions and insights.
- Readers can rate books on a scale of 1 to 5 stars, allowing others to gauge
the overall quality and popularity of a title.
2. Book Details and Recommendations:
- Leveraging an external API, BRP fetches comprehensive information about
books, including author details, publication dates, genres, and cover
images.
- The platform suggests personalized book recommendations based on users’
reading history, preferences, and trending titles.
## Running the project
```bash
poetry install
poetry run serve
```
Docs will be available at `http://http://127.0.0.1:$PORT/docs`
## Style
This projects uses [ruff] as linter and formatter.
To run linter execute the following command:
```bash
poetry run lint
```
To apply linter suggestions run
```bash
poetry run format
```
## Typechecking
This project uses [mypy]
To run typechecker execute the following command:
```bash
poetry run typecheck
```
[ruff]: https://docs.astral.sh/ruff/
[mypy]: https://mypy-lang.org/
## Configuration
Configuration is stored in `settings.toml` and `.secrets.toml` files. Each field
can be overriden by the environment variables with the `BOOK_REVIEW` prefix.
You can see the default values and their description
[here](./book_review/config.py)
## Configuration Options
This table describes the various configuration options available for the application in detail.
| Variable | Default value | Description
| -------- | ------- | ------- |
| DB | "db.sqlite3" | Path to the SQLite database file used for storing book review data.
| PORT | 5000 | Port number on which the HTTP server listens for incoming requests.
| DEBUG | False | Enables debug mode for the application, providing more verbose logging information.
| CORS_ALLOWED_ORIGINS | ["*"] | List of allowed origins for Cross-Origin Resource Sharing (CORS).
| SECRET_KEY | - | Secret key used for signing and verifying JSON Web Tokens (JWT) for authorization.
| ALGORITHM | "HS256" | Algorithm used for signing and verifying JWTs.
| ACCESS_TOKEN_EXPIRE_MINUTES | 60 | Expiration time for JWT access tokens in minutes. After this time, the token will no longer be valid and users will need to re-authenticate.
| CACHE_EXPIRE_MINUTES | 60 * 24 | Time before the Openlibrary client cache expires in minutes. Cached data from Openlibrary will be reused for this duration before fetching fresh information.
| OPENLIBRARY_BASE_URL | "https://openlibrary.org/" | Base URL for the Openlibrary API.
| OPENLIBRARY_COVERS_BASE_URL | "https://covers.openlibrary.org/" | Base URL for fetching book cover images from Openlibrary.