Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
forbiddenvoid authored Jul 5, 2017
1 parent 6fb63b6 commit ae277b5
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,35 @@ This is the starter template for the final assessment project for Udacity's Reac

Of course, you are free to start this project from scratch if you wish! Just be sure to use [Create React App](https://github.com/facebookincubator/create-react-app) to bootstrap the project.

## What You're Getting
```
+--public/
\|-- index.html - DO NOT MODIFY
|-- favicon.ico - React Icon, You may change if you wish.
+-- src/
+-- icons/ - Helpful images for your app. Use at your discretion.
|-- add.svg
|-- arrow-back.svg
|-- arrow-drop-down.svg
|-- App.js - This is the root of your app. Contains static HTML right now.
|-- App.css - Styles for your app. Feel free to customize this as you desire.
|-- 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.
|-- index.js - You should not need to modify this file. It is used for DOM rendering only.
|-- index.css - Global styles. You probably won't need to change anything here.
|-- .gitignore
|-- CONTRIBUTING.MD - Information about contributing to this repo.
TL;DR - Fork and clone your own version of this to use it.
|-- README.MD - This README 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.
```

Remember that good React design practice is to create new JS files for each component and use import/require statements to include them where they are needed.

## 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:
Expand Down

0 comments on commit ae277b5

Please sign in to comment.