https://github.com/dikshant441/personal-bookshelf

https://github.com/dikshant441/personal-bookshelf

Last synced: about 20 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/dikshant441/personal-bookshelf
• Owner: Dikshant441
• Created: 2024-06-10T17:36:19.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-06-10T18:22:31.000Z (7 months ago)
• Last Synced: 2024-11-13T00:19:44.730Z (2 months ago)
• Language: JavaScript
• Homepage: https://personal-bookshelf-alpha.vercel.app
• Size: 174 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Personal Bookshelf

A React-based application that allows users to search for books using the Open Library API and maintain a personal bookshelf in the browser using `localStorage`.

## About the Project

The objective of this project is to provide users with a seamless experience to search for their favorite books and keep track of them in a personal space called "My Bookshelf". Users can add books from search results to their shelf and have the flexibility to remove them as they wish.

## Built With

- [React](https://reactjs.org/)

- [React Router](https://reactrouter.com/)

- [Open Library API](https://openlibrary.org/developers/api)

## Getting Started

### Prerequisites

Ensure you have [Node.js](https://nodejs.org/) and npm installed on your local machine. You can verify if you do by running:

```bash

node -v

npm -v

```

### Installation & Setup

1. **Clone the repository**:

   ```bash

   git clone https://github.com/your-github-username/personal-bookshelf.git

   ```

2. **Navigate to the project directory**:

   ```bash

   cd personal-bookshelf

   ```

3. **Install the required dependencies**:

   This step is crucial for setting up all the necessary dependencies used in the project.

   ```bash

   npm install

   ```

4. **Start the local development server**:

   ```bash

   npm start

   ```

   Once you run this command, the application will start, and it will be accessible at `http://localhost:3000` in your preferred web browser. If it's not show books then try to search a book after that all books will auto show.

5. Visit the application at `http://localhost:3000` in your browser to view the app!

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## Contact

For any queries, reach out to [[email protected]](mailto:[email protected]).

## Known Issues

- There are currently no known issues. If you encounter any, please report them.