Clean up code and instructions

Author: sarah-udacity

README.md

@@ -1,6 +1,6 @@
-# API Development and Documentation Final Project
+# Full Stack API Final Project
 
-## Full Stack Trivia
+## Trivia App
 
 Udacity is invested in creating bonding experiences for its employees and students. A bunch of team members got the idea to hold trivia on a regular basis and created a webpage to manage the trivia app and play the game, but their API experience is limited and still needs to be built out.
 
@@ -16,32 +16,34 @@ Completing this trivia app will give you the ability to structure plan, implemen
 
 ## Starting and Submitting the Project
 
-[Fork](https://help.github.com/en/articles/fork-a-repo) the project repository and [Clone](https://help.github.com/en/articles/cloning-a-repository) your forked repository to your local machine or to the classrooom workspace. Work on the project and make sure to push all your changes to the remote repository before submitting the project.
+[Fork](https://help.github.com/en/articles/fork-a-repo) the project repository and [clone](https://help.github.com/en/articles/cloning-a-repository) your forked repository to your machine. Work on the project locally and make sure to push all your changes to the remote repository before submitting the link to your repository in the Classroom.
 
 ## About the Stack
 
 We started the full stack application for you. It is designed with some key functional areas:
 
 ### Backend
 
-The [./backend](./backend/README.md) directory contains a partially completed Flask and SQLAlchemy server. You will work primarily in `__init__.py` to define your endpoints and can reference models.py for DB and SQLAlchemy setup. These are the files you'd want to edit in the backend:
+The [backend](./backend/README.md) directory contains a partially completed Flask and SQLAlchemy server. You will work primarily in `__init__.py` to define your endpoints and can reference models.py for DB and SQLAlchemy setup. These are the files you'd want to edit in the backend:
 
-1. `./backend/flaskr/__init__.py`
-2. `./backend/test_flaskr.py`
+1. `backend/flaskr/__init__.py`
+2. `backend/test_flaskr.py`
+
+> View the [Backend README](./backend/README.md) for more details.
 
 ### Frontend
 
-The [./frontend](./frontend/README.md) directory contains a complete React frontend to consume the data from the Flask server. If you have prior experience building a frontend application, you should feel free to edit the endpoints as you see fit for the backend you design. If you do not have prior experience building a frontend application, you should read through the frontend code before starting and make notes regarding:
+The [frontend](./frontend/README.md) directory contains a complete React frontend to consume the data from the Flask server. If you have prior experience building a frontend application, you should feel free to edit the endpoints as you see fit for the backend you design. If you do not have prior experience building a frontend application, you should read through the frontend code before starting and make notes regarding:
 
 1. What are the end points and HTTP methods the frontend is expecting to consume?
 2. How are the requests from the frontend formatted? Are they expecting certain parameters or payloads?
 
 Pay special attention to what data the frontend is expecting from each API response to help guide how you format your API. The places where you may change the frontend behavior, and where you should be looking for the above information, are marked with `TODO`. These are the files you'd want to edit in the frontend:
 
-1. `./frontend/src/components/QuestionView.js`
-2. `./frontend/src/components/FormView.js`
-3. `/frontend/src/components/QuizView.js`
+1. `frontend/src/components/QuestionView.js`
+2. `frontend/src/components/FormView.js`
+3. `frontend/src/components/QuizView.js`
 
 By making notes ahead of time, you will practice the core skill of being able to read and understand code and will have a simple plan to follow to build out the endpoints of your backend API.
 
-> View the [README within ./frontend for more details.](./frontend/README.md)
+> View the [Frontend README](./frontend/README.md) for more details.

backend/README.md

@@ -1,18 +1,20 @@
-# Backend - Full Stack Trivia API
+# Backend - Trivia API
 
 ## Installing Dependencies for the Backend
 
+### Installing Dependencies
+
 1. **Python 3.7** - Follow instructions to install the latest version of python for your platform in the [python docs](https://docs.python.org/3/using/unix.html#getting-and-installing-the-latest-version-of-python)
 
-2. **Virtual Enviornment** - We recommend working within a virtual environment whenever using Python for projects. This keeps your dependencies for each project separate and organaized. Instructions for setting up a virual enviornment for your platform can be found in the [python docs](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/)
+2. **Virtual Environment** - We recommend working within a virtual environment whenever using Python for projects. This keeps your dependencies for each project separate and organized. Instructions for setting up a virual environment for your platform can be found in the [python docs](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/)
 
-3. **PIP Dependencies** - Once you have your virtual environment setup and running, install all of the required packages we selected within the `requirements.txt` filed by navigating to the `/backend` directory and running:
+3. **PIP Dependencies** - Once your virtual environment is setup and running, install the required dependencies by navigating to the `/backend` directory and running:
 
 ```bash
 pip install -r requirements.txt
 ```
 
-4. **Key Dependencies**
+#### Key Pip Dependencies
 
 - [Flask](http://flask.pocoo.org/) is a lightweight backend microservices framework. Flask is required to handle requests and responses.
 
@@ -22,7 +24,13 @@ pip install -r requirements.txt
 
 ### Database Setup
 
-With Postgres running, restore a database using the trivia.psql file provided. From the backend folder in terminal run:
+With Postgres running, create a `trivia` database:
+
+```bash
+createbd trivia
+```
+
+Populate the database using the `trivia.psql` file provided. From the `backend` folder in terminal run:
 
 ```bash
 psql trivia < trivia.psql
@@ -40,12 +48,12 @@ flask run --reload
 
 The `--reload` flag will detect file changes and restart the server automatically.
 
-## ToDo Tasks
+## To Do Tasks
 
 These are the files you'd want to edit in the backend:
 
-1. `./backend/flaskr/__init__.py`
-2. `./backend/test_flaskr.py`
+1. `backend/flaskr/__init__.py`
+2. `backend/test_flaskr.py`
 
 One note before you delve into your tasks: for each endpoint, you are expected to define the endpoint and response data. The frontend will be a plentiful resource because it is set up to expect certain endpoints and response data formats already. You should feel free to specify endpoints in your own way; if you do so, make sure to update the frontend or you will get some unexpected behavior.
 
@@ -67,32 +75,31 @@ One note before you delve into your tasks: for each endpoint, you are expected t
 
 9. Create error handlers for all expected errors including 400, 404, 422 and 500.
 
-## Review Comment to the Students
+## Documenting your Endpoints
 
-This README is missing documentation of your endpoints. Below is an example for your endpoint to get all categories. Please use it as a reference for creating your documentation and resubmit your code.
+You will need to provide detailed documentation of your API endpoints including the URL, request parameters and the response body. Use the example below as a reference.
 
-```bash
-Endpoints
-GET '/api/v1.0/categories'
-GET ...
-POST ...
-DELETE ...
+### Documentation Example
+
+GET `'/api/v1.0/categories'`
 
-GET '/api/v1.0/categories'
 - Fetches a dictionary of categories in which the keys are the ids and the value is the corresponding string of the category
 - Request Arguments: None
 - Returns: An object with a single key, categories, that contains a object of id: category_string key:value pairs.
+
+```bash
 {'1' : "Science",
 '2' : "Art",
 '3' : "Geography",
 '4' : "History",
 '5' : "Entertainment",
 '6' : "Sports"}
-
 ```
 
 ## Testing
 
+Write at least one test for the success and at least one error behavior of each endpoint using the unittest library.
+
 To run the tests, run
 
 ```bash

backend/flaskr/__init__.py

@@ -12,93 +12,92 @@ def create_app(test_config=None):
   # create and configure the app
   app = Flask(__name__)
   setup_db(app)
-  
-  '''
+
+  """
   @TODO: Set up CORS. Allow '*' for origins. Delete the sample route after completing the TODOs
-  '''
+  """
 
-  '''
+  """
   @TODO: Use the after_request decorator to set Access-Control-Allow
-  '''
+  """
 
-  '''
-  @TODO: 
-  Create an endpoint to handle GET requests 
+  """
+  @TODO:
+  Create an endpoint to handle GET requests
   for all available categories.
-  '''
+  """
 
 
-  '''
-  @TODO: 
-  Create an endpoint to handle GET requests for questions, 
-  including pagination (every 10 questions). 
-  This endpoint should return a list of questions, 
-  number of total questions, current category, categories. 
+  """
+  @TODO:
+  Create an endpoint to handle GET requests for questions,
+  including pagination (every 10 questions).
+  This endpoint should return a list of questions,
+  number of total questions, current category, categories.
 
   TEST: At this point, when you start the application
   you should see questions and categories generated,
   ten questions per page and pagination at the bottom of the screen for three pages.
-  Clicking on the page numbers should update the questions. 
-  '''
+  Clicking on the page numbers should update the questions.
+  """
 
-  '''
-  @TODO: 
-  Create an endpoint to DELETE question using a question ID. 
+  """
+  @TODO:
+  Create an endpoint to DELETE question using a question ID.
 
   TEST: When you click the trash icon next to a question, the question will be removed.
-  This removal will persist in the database and when you refresh the page. 
-  '''
+  This removal will persist in the database and when you refresh the page.
+  """
 
-  '''
-  @TODO: 
-  Create an endpoint to POST a new question, 
-  which will require the question and answer text, 
+  """
+  @TODO:
+  Create an endpoint to POST a new question,
+  which will require the question and answer text,
   category, and difficulty score.
 
-  TEST: When you submit a question on the "Add" tab, 
+  TEST: When you submit a question on the "Add" tab,
   the form will clear and the question will appear at the end of the last page
-  of the questions list in the "List" tab.  
-  '''
+  of the questions list in the "List" tab.
+  """
 
-  '''
-  @TODO: 
-  Create a POST endpoint to get questions based on a search term. 
-  It should return any questions for whom the search term 
-  is a substring of the question. 
+  """
+  @TODO:
+  Create a POST endpoint to get questions based on a search term.
+  It should return any questions for whom the search term
+  is a substring of the question.
 
-  TEST: Search by any phrase. The questions list will update to include 
-  only question that include that string within their question. 
-  Try using the word "title" to start. 
-  '''
+  TEST: Search by any phrase. The questions list will update to include
+  only question that include that string within their question.
+  Try using the word "title" to start.
+  """
 
-  '''
-  @TODO: 
-  Create a GET endpoint to get questions based on category. 
+  """
+  @TODO:
+  Create a GET endpoint to get questions based on category.
 
-  TEST: In the "List" tab / main screen, clicking on one of the 
-  categories in the left column will cause only questions of that 
-  category to be shown. 
-  '''
+  TEST: In the "List" tab / main screen, clicking on one of the
+  categories in the left column will cause only questions of that
+  category to be shown.
+  """
 
 
-  '''
-  @TODO: 
-  Create a POST endpoint to get questions to play the quiz. 
-  This endpoint should take category and previous question parameters 
-  and return a random questions within the given category, 
-  if provided, and that is not one of the previous questions. 
+  """
+  @TODO:
+  Create a POST endpoint to get questions to play the quiz.
+  This endpoint should take category and previous question parameters
+  and return a random questions within the given category,
+  if provided, and that is not one of the previous questions.
 
   TEST: In the "Play" tab, after a user selects "All" or a category,
   one question at a time is displayed, the user is allowed to answer
-  and shown whether they were correct or not. 
-  '''
-
-  '''
-  @TODO: 
-  Create error handlers for all expected errors 
-  including 404 and 422. 
-  '''
-  
+  and shown whether they were correct or not.
+  """
+
+  """
+  @TODO:
+  Create error handlers for all expected errors
+  including 404 and 422.
+  """
+
   return app
 
-