Skip to content
/ xBook Public

Choose books, read them, rate them, record your notes and leave all the hard parts of managing your bookshelf to us.

Notifications You must be signed in to change notification settings

harshkc/xBook

Repository files navigation

xBook

Website Badge

CircleCI Netlify Status codecov

Application working

Perfect lighthouse score

Note:

This project is not built to WoW anyone but to show the author's good developer practises, testing skills - unit, integration and e2e cypress, performance optimization by lazy loading, memoizing context and caching API calls, advanced patterns like compound components seen in best UI libraries.

What is xBook?

xBook is a simple application to virtualize your bookshelf. Choose books, read them, rate them, record your notes and leave all the hard parts of managing your bookshelf to us.

Overview

  • Find books, decide what to read
  • Add them to the reading list and add your notes
  • Once finished mark them as read and rate them
  • Simple UX, built keeping non-tech humans in mind

USPs

  • 100% screen reader-friendly
  • 100% Caching support for faster subsequent loads
  • SEO friendly
  • Clean and simple UI/UX

Future Scope

  • Dark theme support
  • Migrating project to TypeScript

PRs/Issues are most welcome.

Project setup 💻

> Cloning the repo
    >> git clone https://github.com/harhskc/xBook.git
    >> cd xBook
> Install all dependencies
    >> yarn install
> Run all tests
    >> yarn test
> Start the app on localhost:3000
    >> yarn start
> Visit http://localhost:3000/

About

Choose books, read them, rate them, record your notes and leave all the hard parts of managing your bookshelf to us.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages