Udacity FEND MyReads Project
Starter project files: https://github.com/udacity/reactnd-project-myreads-starter
- The app consists of two pages: the main page and the search page.
- The main page shows 3 shelves with books.
- Clicking on + icon on the main page links to search page, where more books may be added to your shelves.
- You can assign the books to shelves, both from the search page and the homepage.
TL;DR
To run the project:
- download the zip file
- install all project dependencies with
npm install - start the development server with
npm start - the project will run on port 3000 on your localhost
Contents:
├── CONTRIBUTING.md
├── README.md - This file.
├── SEARCH_TERMS.md # The whitelisted short collection of available search terms for you to use with your app.
├── package.json # npm package manager file. It's unlikely that you'll need to modify this.
├── public
│ ├── favicon.ico # React Icon, You may change if you wish.
│ └── index.html # DO NOT MODIFY
└── src
├── App.css # Styles for your app. Feel free to customize this as you desire.
├── App.js # This is the root of your app. Contains static HTML right now.
├── App.test.js # Used for testing. Provided with Create React App. Testing is encouraged, but not required.
├── BooksAPI.js # A JavaScript API for the provided Udacity backend. Instructions for the methods are below.
├── icons # Helpful images for your app. Use at your discretion.
│ ├── add.svg
│ ├── arrow-back.svg
│ └── arrow-drop-down.svg
├── index.css # Global styles. You probably won't need to change anything here.
└── index.js # You should not need to modify this file. It is used for DOM rendering only.
│
│
├── Book.js # Book component (assignment)
├── MainPage.js # Main page component (assignment)
├── SearchPage.js # Search page component (assignment)
│
├── Shelf.js # Test shelf component (TODO)Backend Server
To simplify the development process, Udacity provided a backend server to develop against. The provided file BooksAPI.js contains the methods needed to perform necessary operations on the backend:
getAll
Method Signature:
getAll()- Returns a Promise which resolves to a JSON object containing a collection of book objects.
- This collection represents the books currently in the bookshelves in your app.
update
Method Signature:
update(book, shelf)- book:
<Object>containing at minimum anidattribute - shelf:
<String>contains one of ["wantToRead", "currentlyReading", "read"] - Returns a Promise which resolves to a JSON object containing the response data of the POST request
search
Method Signature:
search(query)- query:
<String> - Returns a Promise which resolves to a JSON object containing a collection of a maximum of 20 book objects.
- These books do not know which shelf they are on. They are raw results only. You'll need to make sure that books have the correct state while on the search page.
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.
Create React App
This project was bootstrapped with Create React App. You can find more information on how to perform common tasks here.
Contributing
This repository is the starter code for all Udacity students. Therefore, we most likely will not accept pull requests.
For details, check out CONTRIBUTING.md.
About Udacity and Google Scholarships
Udacity blog entry announcing Google Developer Challenge 2017/2018