Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/amir-ben-shimol/book-shuffle-app

A React Native mobile app for book lovers to discover and shuffle their reading lists, seamlessly integrating with Goodreads API.
https://github.com/amir-ben-shimol/book-shuffle-app

book expo goodreads goodreads-api react-native

Last synced: about 1 month ago
JSON representation

A React Native mobile app for book lovers to discover and shuffle their reading lists, seamlessly integrating with Goodreads API.

Host: GitHub
URL: https://github.com/amir-ben-shimol/book-shuffle-app
Owner: amir-ben-shimol
License: mit
Created: 2024-07-16T07:20:27.000Z (5 months ago)
Default Branch: main
Last Pushed: 2024-10-18T14:20:32.000Z (2 months ago)
Last Synced: 2024-10-19T11:18:33.327Z (2 months ago)
Topics: book, expo, goodreads, goodreads-api, react-native
Language: TypeScript
Homepage:
Size: 12.8 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 13
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS

Awesome Lists containing this project

README

# Shuffle Book App

Welcome to the Shuffle Book App! This app allows users to explore and shuffle through books based on their preferences. Additionally, users can upload their `.csv` file export of book lists from Goodreads, integrate with their Goodreads account, and utilize the Goodreads API for displaying detailed book information. Below is an overview of the app, including the technologies used, linters and CI/CD setup, and the main features.

## Getting Started

To get started with the development of this app, follow these steps:

1. Clone the repository.
2. Install the dependencies using `pnpm install`.
3. Run the app using `pnpm dev`.

## App Features

- **Upload Goodreads CSV**: Users can upload their `.csv` file export of book lists from Goodreads.
- **Goodreads Integration**: The app integrates with the user's Goodreads account, allowing seamless access to their book information.
- **Goodreads API**: Utilizes the Goodreads API to display detailed book information, including cover, title, author, description and similar books.
- **Book Search**: Users can search for books using the Goodreads API and add them to their library.
- **Detailed Book Info**: Includes title, author, description, and reviews count for each book.
- **Shuffle Book**: Allows users to shuffle books based on various filters.

## Technologies Used

- **Expo**: Utilized for building the app with an app router structure.
- **EAS Build Services**: For building the app.
- **Renovate**: For automated dependency updates.
- **Semantic Release**: For automated versioning and package publishing.
- **Storybook**: An interactive environment for developing and testing UI components in isolation.
- **Jest**: A testing framework for unit and integration tests.
- **TypeScript**: Ensuring type safety and better development experience.
- **ESLint**: For identifying and reporting on patterns found in ECMAScript/JavaScript code.
- **Prettier**: An opinionated code formatter to ensure consistent code style.
- **inflint**: For defining and insuring file name conventions.
- **knip**: For unused files and exports.
- **lint-staged**: To run linters on staged files before committing.
- **Husky**: Used in combination with lint-staged to check code before committing.

## Project Environment

- **pnpm**: >=9
- **node**: >=20

## CI/CD Setup

- **GitHub Actions**: Used for continuous integration and continuous deployment (CI/CD). The workflow checks code conventions based on the linter configurations.

## Storybook

- **Storybook**: Configured for all UI components, providing an interactive environment for developing and testing components in isolation. To start Storybook, run `pnpm storybook`.

## Testing

- **Jest**: Used for unit and integration testing. Tests are written for all components and features to ensure correctness and reliability. To run tests, use `pnpm test:storybook`.

## Screenshots

### Library View and Recently Viewed Books Section

Library view showing a collection of book covers arranged in a grid layout
Recently viewed books section

### Book Information Page and Similar Books Section

Book information page
Similar books section showcasing a selection of book covers related to the current book

### Shuffle Your Book Feature and Shuffled Book Result

Shuffle your book feature interface with a button to start shuffling books
Result of a shuffled book displaying a randomly selected book cover and its title

### Filter Preferences Screen

Filter preferences screen allowing users to set criteria before shuffling books

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.