cykj40 / book-search-engine

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Book Search Engine

badge

Description

This application is a book search engine. Users can create an account. Users can search for books and read descriptions 
about each book. Users can save the names and descriptions of books they want to read. Users can also remove books from 
their saved book's list. 

Table of Contents

About

This project is a fully functional full stack MERN application. Some of the technoligies I used to make this app are as 
follows.

* MongoDB
* Express.js
* React.js
* Node.js
* Javascript
* GraphQL API
* Apollo Server

User Story

AS AN avid reader
I WANT to search for new books to read
SO THAT I can keep a list of books to purchase

Acceptance Criteria

GIVEN a book search engine
WHEN I load the search engine
THEN I am presented with a menu with the options Search for Books and Login/Signup and an input field to search for books and a submit button
WHEN I click on the Search for Books menu option
THEN I am presented with an input field to search for books and a submit button
WHEN I am not logged in and enter a search term in the input field and click the submit button
THEN I am presented with several search results, each featuring a book’s title, author, description, image, and a link to that book on the Google Books site
WHEN I click on the Login/Signup menu option
THEN a modal appears on the screen with a toggle between the option to log in or sign up
WHEN the toggle is set to Signup
THEN I am presented with three inputs for a username, an email address, and a password, and a signup button
WHEN the toggle is set to Login
THEN I am presented with two inputs for an email address and a password and login button
WHEN I enter a valid email address and create a password and click on the signup button
THEN my user account is created and I am logged in to the site
WHEN I enter my account’s email address and password and click on the login button
THEN I the modal closes and I am logged in to the site
WHEN I am logged in to the site
THEN the menu options change to Search for Books, an option to see my saved books, and Logout
WHEN I am logged in and enter a search term in the input field and click the submit button
THEN I am presented with several search results, each featuring a book’s title, author, description, image, and a link to that book on the Google Books site and a     button to save a book to my account
WHEN I click on the Save button on a book
THEN that book’s information is saved to my account
WHEN I click on the option to see my saved books
THEN I am presented with all of the books I have saved to my account, each featuring the book’s title, author, description, image, and a link to that book on the       Google Books site and a button to remove a book from my account
WHEN I click on the Remove button on a book
THEN that book is deleted from my saved books list
WHEN I click on the Logout button
THEN I am logged out of the site and presented with a menu with the options Search for Books and Login/Signup and an input field to search for books and a submit       button  

Screenshots

landingpage

Searchresults Savedbooks

Link to deployed site

Click Here 🔥

Installation

* go to my github clone the project book serach engine
* Run npm install
* Run npm run develop
* Go to MongoDb Atlas create a database, copy your connection uri
* go to Heroku create a heroku app. add your connection URI for your mongodb to the config vars.
* run git push heroku main in your cli.
* run Heroku open
* Deploy and enjoy!

License

badge
This application is licensed by MIT

Test

none

Contributers

Cyrus Khiabani

Questions

Contact Me

email me cyrusk81@gmail.com

find me on Github, cykj40

This Readme was made by 🚀 Cy ⚡

About


Languages

Language:JavaScript 93.8%Language:HTML 5.7%Language:CSS 0.6%