Skip to content

HarihararamSriram/vpt-2022-dec--Harihararam-KaushikS-NavinPraanav-Janath-Fazil

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 

Repository files navigation

vpt-2022-dec-IT_G1Team

+

Venmurasu Online Programming Qualifier Round

Project Deployment: (https://main--sprightly-pothos-68395a.netlify.app/)

OpenLibrary API based dashboard


Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. License
  5. Contact
  6. Acknowledgments

About The Project



Implementation details

The API's documentation and source code were thoroughly analysed to learn about the parameters that can be used and how the results of the response were formatted. It is used to get information about the book and author when the user searches a query. This web API integration is implemented using Axios Asynchronously to impose minimal load to the client.

Now for the Front-end we started with React library and built the landing page and when searched for a query we added a dynamic viewing of the books. The reason we have inclined to use React is that it is painless to create interactive UIs. Designing simple views for each state in the application and React will efficiently update and render just the right components when your data changes. CSS used for styling and decorating the User Experience even more that the Experience given by React JS.

Axios is a promise-based HTTP Client for Node.js and the browser. We have used this because it simplifies the complexity of fetching the information from the Rest API.

Why and What?

APIs let your product or service communicate with other products and services without having to know how they’re implemented. This is to simplify app development, saving time and money. When you’re designing new tools and products—or managing existing ones—APIs give you flexibility; simplify design, administration, and use; and provide opportunities for innovation.

Open Library is an online project intended to create "one web page for every book ever published". Implementation of web application client using the Open Library API. The Web API used extensively are search and books Web API.

A special thanks to Venmurasu team for giving us an amazing opportunity to work with this wonderful API.

(back to top)

Built With

The Application was built using the following technologies

  • OpenLibrary Web API
  • React JS
  • HTML
  • CSS
  • Axios

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps or rev up the demo website.

Prerequisites

  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo
    git clone git@github.com:HarihararamSriram/vpt-2022-dec-IT_G1Team.git
  2. Install NPM packages
    npm install
  3. Run the local server
    npm start

(back to top)

Usage

. The books can be retrieved using a query. . The books can be retrieved using keywords. . The books can be retrieved using Author name. . The books when clicked gives access to properties like recent publication, genre, etc.

For more examples, please use the demo or refer to the API's documentation as the project is in direct implementation of a client for the search and books API

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact


Project Link: [https://github.com/venmurasu-programming-team/2022-Dec-Contest](https://github.com/venmurasu-programming-team/2022-Dec-Contest)

Problem statement: https://github.com/venmurasu-programming-team/2022-Dec-Contest

(back to top)

Acknowledgments

(back to top)

About

Venmurasu Online Programming Qualifier Repository

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •