https://github.com/anirudhramanan/myreads-reactjs-book-tracking-app
Udacity React Nanodegree Starter Project
https://github.com/anirudhramanan/myreads-reactjs-book-tracking-app
backend-server bootstrap facebook javascript npm react
Last synced: about 2 months ago
JSON representation
Udacity React Nanodegree Starter Project
- Host: GitHub
- URL: https://github.com/anirudhramanan/myreads-reactjs-book-tracking-app
- Owner: anirudhramanan
- Created: 2017-07-02T09:39:19.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-07-08T19:53:09.000Z (almost 9 years ago)
- Last Synced: 2025-06-02T22:47:24.513Z (about 1 year ago)
- Topics: backend-server, bootstrap, facebook, javascript, npm, react
- Language: JavaScript
- Homepage:
- Size: 126 KB
- Stars: 0
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
## myReads: Your Personal Library
This is a simple react app that allow users to search for books and categorize them.
## Getting Started :
1. git clone 'https://github.com/anirudhramanan/MyReads-ReactJs-Book-Tracking-App'
2. Navigate to the repository, and run 'npm install'
3. 'npm start' to start the app
4. Open 'http://localhost:3000/' on web browser.
## BooksAPI Overview :
### `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(book, shelf)`
* book: `` containing at minimum an `id` attribute
* shelf: `` contains one of ["wantToRead", "currentlyReading", "read"]
* Returns a Promise which resolves to a JSON object containing the response data of the POST request
### `search(query, maxResults)`
* query: ``
* maxResults: `` Due to the nature of the backend server, search results are capped at 20, even if this is set higher.
* Returns a Promise which resolves to a JSON object containing a collection of 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](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](https://github.com/facebookincubator/create-react-app). You can find more information on how to perform common tasks [here](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md).