Bookr 簿客

An awesome bookshelf app built with React & friends! (Built for personal use)
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

The React and JavaScript ecosystem is full of tools and libraries to help us build our applications. In this project, I built this bookshelf application from scratch using my favorite widely supported and proven tools and techniques. I'll cover everything about building frontend React applications, from the absolute basics to the tricky parts I'll run into building real-world React apps and how to create concise abstractions.

A list of commonly used resources that I find helpful are listed in the acknowledgements.

Built With

Tools

• React
• Create React App
• Emotion
• React Query
• Vercel Design
• React Router Web
• Reach UI
• React Icons
• react-parallex-tilt
• Bootstrap
• Jest
• React Testing Library
• Cypress
• Prettier
• lint-staged
• husky
• msw
• match-sorter

Topics covered in this app

1. Basic Rendering
2. Styling
3. Data fetching
4. Authentication
5. Routing
6. Cache management
7. Context
8. Compound components
9. Performance
10. Render as you fetch
11. Unit testing
12. Testing hooks & components
13. Integration testing
14. E2e testing

Getting Started

Prerequisites

npm or yarn

npm install npm@latest yarn@latest -g

Installation & Usage

 git clone https://github.com/Neo42/bookr.git
 cd bookr
 npm i && npm start
 # or
 yarn && yarn start

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact Me

Hao Jiang

• Personal site: Neo42 (with a contact page)
• Twitter: @Hao
• Email: haojiang_neo42@163.com

Project Link: https://github.com/Neo42/bookr