- Description
- User Story
- Acceptance Criteria
- MVP
- Reference Links
- Installation Instructions
- Demo
- Licensing
Google Books Platform allows the user search and view saved google books.
-
Search - User can search for books via the Google Books API and render them here. User has the option to "View" a book, bringing them to the book on Google Books, or "Save" a book, saving it to the Mongo database.
-
Saved - Renders all books saved to the Mongo database. User has an option to "View" the book, bringing them to the book on Google Books, or "Delete" a book, removing it from the Mongo database.
As a user, I want to be able to search for books, view book details, and save it.
- As a User I can search google books
- As a User I can view google book details page
- As a User I can save google books
- As a User I can delete google books
- Allow user to be able to search google books
- Allow user to be able to view google book details page
- Allow user to be able to save google books
- Allow user to be able to delete google books
Link to Google Books deployed on Heroku - Google Books Live App
Link to GitHub Repo used for application development - Google Books GitHub Repo
To test this project, simply follow these steps:
Pre-requirements: Have an available connection to Mongo database
-
Make sure node.js is installed in your machine. If not is installed in your machine click here to download the application.
-
Run
npm install or npm i
in your terminal in order to install all required node modules listed in the package.json. -
Clone the following project into a your local file system
git clone https://github.com/ystamaritq/books-search.git
-
Then
run node server.js
in order to start locally the App/
The Google Books is based on MERN stack which is the combination of technologies used to create a web application. MERN includes four open-source components: MongoDB, Express, React, and Node.js where:
- MongoDB: A cross-platform document database
- Express: A back-end web application framework, minimalist web framework for node.
- React: A JavaScript library for building user interfaces
- Node.js: A cross-platform JavaScript runtime environment
The dependencies listed below are all the NPM packages used throughout this project.
mongoose
- Object modeling tool designed to work in an asynchronous environmentantd
- Ant Design React UI CSS librarygoogle-books-search
- A simple Node.js client for the Google Books API.react-router-dom
- DOM bindings for React Router
"The code in this project is licensed under MIT license."
**developed with love by **@ystamaritq****