https://github.com/richardzhang01/book-search-engine

A book search engine that allows users to find and save books to a personal list. Powered by the Google Books API, built using the MERN stack. and featuring Apollo Server & GraphQL.
https://github.com/richardzhang01/book-search-engine

Last synced: 4 days ago
JSON representation

A book search engine that allows users to find and save books to a personal list. Powered by the Google Books API, built using the MERN stack. and featuring Apollo Server & GraphQL.

• Host: GitHub
• URL: https://github.com/richardzhang01/book-search-engine
• Owner: RichardZhang01
• Created: 2022-07-21T00:29:49.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-01T04:17:23.000Z (about 2 years ago)
• Last Synced: 2023-03-06T20:11:04.000Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 19.6 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Book Search Engine

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) 

[![Tech-blog-app-button](https://www.herokucdn.com/deploy/button.svg)](https://arcane-savannah-69611.herokuapp.com/)

## Description

- This application allows users to search for books and save them to a personal list. The search engine utilizes the Google Books API. The frontend is created with REACT and is connected to a MongoDB backend through Apollo Server and GraphQL. 

## Table of Contents

1. [Installation](#installation)

2. [Usage](#usage)

3. [Demonstration](#demonstration)

4. [License](#license)

5. [How to Contribute](#how-to-contribute)

6. [Questions?](#questions)

## Installation

**This application is deployed to Heroku, and you can access it [here](https://arcane-savannah-69611.herokuapp.com/).**

Alternatively, you can clone this repo. 

If performing a manual installation, you need [Node.js](https://nodejs.org/en/).

To install dependencies, open in [Visual Studio Code](https://code.visualstudio.com/), and in the terminal run: 

      npm install 

## Usage

**This application is deployed to Heroku, and you can access it [here](https://arcane-savannah-69611.herokuapp.com/).**

Alternatively, once the application is installed and opened in Visual Studio Code, or navigated to using Git Bash (or similar command-line tool), run: 

      npm start 

The application runs locally on port 3000.

Once the server has been started, in your browser, navigate to http://localhost:3000

##  Demonstration

**This application is deployed to Heroku, and you can access it [here](https://arcane-savannah-69611.herokuapp.com/).**

some screenshots:

![Screenshot of the Search Engine](./assets/images/screenshot-1.png)

![Screenshot of the Save Books Feature](./assets/images/screenshot-2.png)

![Screenshot of the user dashboard with saved books](./assets/images/screenshot-3.png)

![Screenshot of the Delete Books Feature](./assets/images/screenshot-4.png)

## License

This application is covered under the [MIT](https://opensource.org/licenses/MIT) license

----------------------------------------------------------------

  Copyright © 2022 Richard Zhang

  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

  

  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

  

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

  ----------------------------------------------------------------

## How to Contribute

If you want to contribute to this project and make it better, your help is very welcome. This was a school project, so anything you want to do to it, go for it. You can also contact me directly through the links below.

## Questions?

Have any questions? Here is a list of my links:

- GitHub: [RichardZhang01](https://github.com/RichardZhang01)

- Email: [email protected]