Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 1.88 KB

README.md

File metadata and controls

55 lines (35 loc) · 1.88 KB
Raw

MyReads Project

This project was developed for an assessment for Udacity's React Nanodegree course.

Table of Contents

Project Details

The project is a Book Shelf App called MyReads. With this App, you can search and organize your favorite books by personal categories as "current reading", "want to read" and "read".

This project was bootstrapped with Create React App.

Special Features

  • Responsive Layout and Components
  • Material Design using Material-UI
  • All styles using JSS (css in js) JSS
  • Sidebar Menu (mobile too)
  • Dedicated page for every category (current reading, want to read and read)
  • Loading state component
  • Unit and integration testing

Installing and Running

  • Install all project dependencies with yarn install
  • Start the development server with yarn start

runs on localhost:3000

Running Tests

This project uses Jest (preconfigured by Create React App) and Enzyme that improves the testing techniques for React applications.

  • Run all tests yarn test
  • Run all tests with coverage reporting yarn test-coverage

Backend Server

The backend server is provided by Udacity's API, so you need internet connection to run the project, even locally.

Important

The backend API uses a fixed set of cached search results and is limited to a particular set of search terms, which can be found in SEARCH_TERMS.md. That list of terms are the only terms that will work with the backend, so don't be surprised if your searches for Basket Weaving or Bubble Wrap don't come back with any results.