Skip to content

rpt12-knightrider/jb-service

Repository files navigation

About The Author module from goodreads

The module will display author info of the book that is displayed. Specifically, this module will display the author's name, number of followers, and a biography. Also, the top 5 books of that author will display along with a pop-up window with detailed book information that displays if the user hovers over a particular book title.

Related Projects

Table of Contents

  1. Usage
  2. Requirements
  3. Development

Usage

Initial Setup

Complete these two steps ONCE before starting the application for the first time:

  1. npm install -g webpack to install webpack globally.
  2. npm install to install dependencies.
  3. npm run create-db to create MySql database for the application.

Regular Usage

To start the application, Please run the following "package.json" scripts:

  1. npm run build to start Webpack.
  2. npm run start to start the Node server.
  3. npm run seed to add fake data to the db.

Requirements

An nvmrc file is included if using nvm.

  • Node 10.13.0
  • etc

Development

API Endpoints

URL: /author
Description: This example retrieves an author's name, number of follwers, and a biography.
API Response:

{
  "name":"Rosalinda Kutch IV",
  "followers":91593,
  "biography":"Sunt sed vitae aliquid. Qui libero
  et explicabo maxime veritatis asperiores quia et
  mollitia. Dolor ipsam   laboriosam libero tempore."
  "author_image": '[link to image]'
}

URL: /five-books-by-author
Description: This example retrives a maximum of five books written by an author.
API Response:

{
  "titles":
  [
    "Licensed Rubber Cheese",
  "Incredible Frozen Pants",
  "Handcrafted Wooden Bike",
  "Practical Steel Pizza",
  "Incredible Wooden Sausages"
  ]
}

URL: book-item-hover-window
Description: This example retrieves a book's title, total number
of ratings, the average rating, the year of publication, and a description of the book.
API Response:

{<br>
  "title":"Handcrafted Rubber Table",
  "total_ratings":18274,
  "average_ratings":"4",
  "year":2007,
  "description":"Eum hic dolorem. Illum omnis tenetur atque
  iusto non. Iste placeat et amet cupiditate quo."
}

New Document

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published