https://github.com/d-4-dibakar/books-listing
https://github.com/d-4-dibakar/books-listing
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/d-4-dibakar/books-listing
- Owner: D-4-DIBAKAR
- Created: 2024-11-18T21:13:19.000Z (12 months ago)
- Default Branch: Master
- Last Pushed: 2024-11-18T23:07:11.000Z (12 months ago)
- Last Synced: 2025-01-26T16:12:30.027Z (9 months ago)
- Language: JavaScript
- Size: 69.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Book Listing App
The **Book Listing App** is a web application built using React, designed to help users manage a collection of books. It allows users to view, add, and delete books while seamlessly integrating with a backend API. The app features a clean UI, toast notifications for feedback, and responsive design with TailwindCSS.
---
## Features
### 📚 Core Features
- **View Books**: Displays a list of books with details like title, author, and description.
- **Add a Book**: Add new books to the list with a simple form.
- **Delete a Book**: Remove books from the list with a single click.
- **Dynamic Updates**: Books are added or removed instantly without requiring a page refresh.
### ✨ User Experience Enhancements
- **Toast Notifications**: Users receive feedback for actions (e.g., book added, or deleted) using `react-toastify`.
- **Loading Indicators**: Shows a loading state when fetching or modifying data.
- **Responsive Design**: The interface is fully responsive and looks great on all devices.
---
## Technologies Used
### Frontend
- **React**: Component-based UI framework.
- **TailwindCSS**: For responsive and modern UI styling.
- **React Toastify**: For user-friendly toast notifications.
- **Prop Types**: For runtime type-checking of props.
### Backend
- **Node.js**: Server runtime.
- **Express.js**: RESTful API for handling book operations.
- **Database (Optional)**: Integrate MongoDB or any preferred database for persistent data storage.
---
## Prerequisites
Before you begin, make sure you have the following installed:
- **Node.js**: Version 14 or later.
- **npm**: Version 6 or later.
- A browser that supports modern JavaScript features.
---
## Installation and Setup
1. Clone the repository:
```bash
git clone https://github.com/D-4-DIBAKAR/Books-Listing.git
cd Books-Listing
```
2. Install dependencies:
```bash
npm install
```
3. Start the development server:
- Backend
```
npm start
```
- Frontend
```
npm run dev
```
## Live Demonstration
- **Frontend**: [View on Netlify](https://comfy-hotteok-f84fa8.netlify.app/)
- **Backend API**: [View on Render](https://books-listing.onrender.com)
- **API Documentation**: [View Postman Docs](https://documenter.getpostman.com/view/27911731/2sAYBREtEG)
## API Endpoints
- GET /books: Fetch all books.
- POST /books: Add a new book (requires `title`, `author`, and `description`).
- DELETE /books/
: Delete a book by ID.
## Snapshots
## 📸 Frontend
## 📸 Backend
## Contribution
If you'd like to contribute to this project:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Submit a pull request with a detailed explanation of your changes.
Happy coding! 😊