As an avid reader, I want to search for new books to read so that I can keep a list of books to purchase.
Explore the docs »
View Demo
.
Report Bug
·
Request Feature
Link web page: https://dg-book-search-engine.herokuapp.com/
Table of Contents
GIVEN a book search engine
-
Loading the search engine, I will 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.
-
Clicking on the Search for Books menu option, I will presented with an input field to search for books and a submit button.
-
If I am not logged in and enter a search term in the input field and click the submit button, I will be 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.
-
Clicking on the Login/Signup menu option,a modal will appear on the screen with a toggle between the option to log in or sign up.
-
If the toggle is set to Signup, I am presented with three inputs for a username, an email address, and a password, and a signup button.
-
If the toggle is set to Login, I am presented with two inputs for an email address and a password and login button.
-
Entering a valid email address and create a password and click on the signup button, my user account will be created and I am logged in to the site.
-
Entering my account’s email address and password and click on the login button, the modal closes and I am logged in to the site.
-
If I am logged in to the site, the menu options change to Search for Books, an option to see my saved books, and Logout.
-
Being logged in and enter a search term in the input field and click the submit button, 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.
-
Clicking on the Save button on a book, that book’s information is saved to my account.
-
Clicking on the option to see my saved books, 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.
-
Clicking on the Remove button on a book, that book will be deleted from my saved books list.
-
Clicking on the Logout button, 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.
- Simply copy the SSH to the terminal or Download the ZIP File:
-
Use the follow command at your terminal, git clone (Create a working copy at your local repository):
git clone git@github.com:Derimarg/book-search-engine.git -
After cloned the repository, create your own repository, copy the files to your repository and type in your terminal the follow commands.
git status git add -A git commit -m "Message to commit." git push or git push origin main
Before of using this application, is require to install dependencies, run the following command in your terminal:
npm install
This is a open source program, feel free to use it, contact me to request features.
"scripts": {
"start": "if-env NODE_ENV=production && npm run start:prod || npm run start:dev",
"start:prod": "cd server && npm start",
"start:dev": "concurrently \"cd server && npm run watch\" \"cd client && npm start\"",
"install": "cd server && npm i && cd ../client && npm i",
"heroku-postbuild": "cd client && npm run build"
}Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Will deploy app to heroku
See the open issues for a list of proposed features (and known issues).
Contributions are part of this open source project. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/name-of-feature) - Commit your Changes (
git commit -m "Add some feature") - Push to the Branch (
git push origin feature/name-of-feature) - Open a Pull Request
For additional help or questions about collaboration, contact me at: derimargray@gmail.com
- GitHub - Derimarg
- Linkedin - Derimar Gray
- Project Repository Link: https://github.com/Derimarg/book-search-engine
MIT License
Copyright (c) 2021 Derimar Gray
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.