Git Product home page Git Product logo

goodreads-challenge's Introduction

INTRODUCTION

A React app which can be used to see the detailed information about books from GoodReads.com.

REMOVED CORS-ANYWHERE.COM

The app now uses its own Express API to mitigate CORS related issues. It is not dependent on any third party endpoint anymore.

MOCKUP

I created the following wireframe to decide on the key features of the prospective product.

SETUP

  1. The project is based on Next.js.
  2. The project follows styled-css methodology for styling, due to Next.js.
  3. All the major React components can be found under components folder.
  4. For state management, the project uses Redux.
  5. All state management and data fetching logic can be found under redux folder.
  6. The UI is built using CSS3 Flexbox.
  7. The project uses Eslint for checking common linting errors.
  8. The production site is hosted on Heroku. Check it out.

RUNNING AND DEBUGGING

  1. To start the development server locally
npm run dev
  1. To run tests
npm run test
  1. To run the linter
npm run lint
  1. To fix common linting errors
npm run lint -- --fix

FUTURE IMPROVEMENTS

  • Development Side:

    • Use something like Flow or React.propTypes for strict typing.
    • Constants like developer keys etc., can be stored and loaded with libraries like dot-env.
    • Ensure consistent BEM based naming convention for CSS classes.
  • UI/UX Side:

    • As of now, an in-transition search cannot be cancelled, would like to make it cancellable.
    • Under the Description section, the app renders CDATA, instead of plain text. It could be handled appropriately.
    • To make it more responsive for smaller screens.
    • The Book list can be made to scroll, so as to fit the overflowing UI into the viewport.

goodreads-challenge's People

Stargazers

Roman avatar

Watchers

Rajat Saxena avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.