Skip to content

Commit

Permalink
Updates
Browse files Browse the repository at this point in the history
Signed-off-by: T. Lanette <[email protected]>
  • Loading branch information
tlanettepollard committed May 15, 2022
1 parent bf4fa42 commit 5d19e5d
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 1 deletion.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,41 @@ I decided to start over because I was getting confused with how I was passing my
- [Kenodipe](https://www.youtube.com/watch?v=DNdZ3-MiF1E&t=590s&ab_channel=kenjournal)

---

# Initiate the Project

To initiate this project complete the following steps:

- 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
├── 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)
2 changes: 1 addition & 1 deletion project.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ To get started developing right away:
- install all project dependencies with `npm install`
- start the development server with `npm start`

## What You're Getting
## Directory Hierarchy

```bash
├── CONTRIBUTING.md
Expand Down

0 comments on commit 5d19e5d

Please sign in to comment.