BookBuddy is a personal book tracking application to help you manage your reading list and keep track of your progress.
- Track Your Reading: Keep a digital library of books you're reading or have completed
- Organize Your Collection: Filter books by reading status (Reading/Completed)
- Persistence: Your book data is saved in your browser's local storage
- Responsive Design: Works smoothly on both mobile and desktop devices
- React: Frontend UI library
- React Router: For navigation
- Context API: For state management
- React Hook Form: For form handling
- Tailwind CSS: For styling
- Local Storage API: For data persistence
- Node.js (v14 or later)
- npm or yarn
- Clone the repository
git clone https://github.com/yourusername/bookbuddy.git
cd bookbuddy- Install dependencies
npm install
# or
yarn install- Start the development server
npm run dev
# or
yarn dev- Open your browser and navigate to
http://localhost:5173
├── public/ # Static files
├── src/ # Source files
│ ├── components/ # Reusable UI components
│ ├── context/ # React context for state management
│ ├── hooks/ # Custom React hooks
│ ├── pages/ # Application pages
│ ├── types/ # JSDoc type definitions
│ ├── App.jsx # Main App component
│ └── main.jsx # Application entry point
└── index.html # HTML entry point
- View Books: Navigate to "My Books" to see your collection
- Add a Book: Click on "Add Book" to add a new book to your collection
- Change Status: Click the book icon to toggle between "Reading" and "Completed"
- Remove Book: Click the trash icon to remove a book from your collection
- Filter Books: Use the filter buttons to view specific categories of books
Contributions are welcome! Please feel free to submit a Pull Request.
This project is licensed under the MIT License - see the LICENSE file for details.