Merge pull request #77 from SCCapstone/readme-updates

final: updates to readme

README.md

@@ -3,24 +3,28 @@ We are making a Bookstore App that renders on both mobile and desktop web device
 
 ## External Requirements Installation
 In order to build this project install:
+* [Node Package Manager](https://www.npmjs.com/)
 * [Node.js](https://nodejs.org/en/)
+* All of the required packages, APIs, and libraries - description for how to do this in Setup.
 
 ## Setup
 Before running the app a few things have to be installed in both the client and backend. Run these instructions in the terminal:  
 #### Base Folder 
 Ensure you are in "BufferOverload" and run these commands:  
 `npm i`  
-`npm i react-scripts`  
-`npm i -S concurrently` (Used for running npm start in the terminal)  
 
 #### Back-End  
-`cd` into the backend folder and run: `npm i -S mongoose express body-parser morgan cors`  
+`cd` into the backend folder and run: `npm i`  
 
 #### Client    
-`cd` into the client folder and run: `npm i -S axios register-service-worker @emailjs/browser react-icons` 
+`cd` into the client folder and run: `npm i && npm run build` 
+
+NOTE: If you are running locally, you will need a `.env` file which contains, among other things,
+private keys for authentication. Contact the developers for more information about this.
 
 ## Running
 To run the app make sure to cd into the base-folder (Buffer-Overload) and run `npm start` in the terminal.
+The terminal should tell you what port it launches on (usually 3001). Navigate to `localhost:3001/` or equivalent.
 
 # Deployment
 To deploy our bookstore web application we plan on using Heroku. Embedded into Heroku comes the option of using the mongoDB database which will be used for storing user information and the book inventory. Integrated with this, we plan to use the Amazon API for book browsing and potential book purchases. The stored user information and book inventory will follow JSON formatting. https://www.heroku.com/
@@ -30,11 +34,8 @@ In using Heroku as the method to deploy our bookstore web application, we will b
 We will use a traditional web app model because the Heroku hosting platform will easily handle the small load of server operations for our app.
 
 
-In 492 we will write automated tests for our app. TO-DO
 ## Testing
-The unit tests are in `/test/unit`.
-
-The behavioral tests are in `/test/casper/`.
+In 492 we plan to write tests for our app.
 
 ## Testing Technology
 
@@ -45,6 +46,7 @@ In some cases you need to install test runners, etc. Explain how.
 Explain how to run the automated tests.
 
 ## Authors
+
 * Rahul Bulusu: [email protected]
 * William Hobbs: [email protected]
 * Jack Oberman: [email protected]