https://github.com/jkmagnussen/myreads-a-book-tracking-app
Developed a web app that allows for the selection and categorisation of books the user has read, is reading and wants to read as an assessed project within Udacity's React Nanodegree
https://github.com/jkmagnussen/myreads-a-book-tracking-app
Last synced: 3 days ago
JSON representation
Developed a web app that allows for the selection and categorisation of books the user has read, is reading and wants to read as an assessed project within Udacity's React Nanodegree
- Host: GitHub
- URL: https://github.com/jkmagnussen/myreads-a-book-tracking-app
- Owner: jkmagnussen
- Created: 2020-01-24T15:06:06.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T18:05:28.000Z (over 2 years ago)
- Last Synced: 2025-03-14T11:44:22.674Z (3 months ago)
- Language: JavaScript
- Homepage: https://jkmagnussen-myreads.netlify.com/
- Size: 62 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# MyReads React Project
JKMagnussen
This is my final assessment project for Udacity's React Fundamentals course.
To initiate this project:
install all project dependencies with `npm install`.
Then run, `npm start` to display the application..
## Directory Hierarchy
```bash
├── 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
├── components
├── Book.js
│ ├── Bookshelf.js
│ └── Search.js
├── 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.
```
## Backend Server
To simplify your development process, we've provided a backend server for you to develop against. The provided file [`BooksAPI.js`](src/BooksAPI.js) contains the methods you will need to perform necessary operations on the backend:
- [`getAll`](#getall)
- [`update`](#update)
- [`search`](#search)