This project is a game where users can test their knowledge answering trivia questions. The task for the project was to create an API and test suite for implementing the following functionality:

1. Display questions - both all questions and by category. Questions should show the question, category and difficulty rating by default and can show/hide the answer.
2. Delete questions.
3. Add questions and require that they include question and answer text.
4. Search for questions based on a text query string.
5. Play the quiz game, randomizing either all questions or within a specific category.

Developers using this project should already have Python3, pip, node, and npm installed.

This project uses NPM to manage software dependencies. NPM Relies on the package.json file located in the /starter/frontend directory of this repository. After cloning, open your terminal and run:

npm install

Once you have your virtual environment setup and running, install dependencies by navigating to the /starter/backend directory and running:

pip install -r requirements.txt

The frontend app was built using create-react-app. In order to run the app in development mode use npm start. You can change the script in the package.json file.

Open http://localhost:3000 to view it in the browser. The page will reload if you make edits.

npm start

From within the /starter/backend directory first ensure you are working using your created virtual environment.

To run the server, execute:

export FLASK_APP=flaskr
export FLASK_ENV=development
flask run

Windows users:

set FLASK_APP=flaskr
set FLASK_ENV=development
set run

To run the tests, run

dropdb trivia_test
createdb trivia_test
psql trivia_test < trivia.psql
python test_flaskr.py

Omit the dropdb command the first time you run tests.

• Base URL: Currently this application is only hosted locally. The backend is hosted at http://127.0.0.1:5000/
• Authentication: This version does not require authentication or API keys.

Errors are returned as JSON in the following format:

{
    "success": False,
    "error": 404,
    "message": "resource not found"
}

The API will return three types of errors:

• 400 – bad request
• 404 – resource not found
• 422 – unprocessable

• General: Returns a list categories.

• Sample: curl http://127.0.0.1:5000/categories
  

    {
        "categories": {
            "1": "Science", 
            "2": "Art", 
            "3": "Geography", 
            "4": "History", 
            "5": "Entertainment", 
            "6": "Sports"
        }, 
        "success": true
    }
  

• General:

  • Returns a list questions.
  • Results are paginated in groups of 10.
  • Also returns list of categories, current category and total number of questions.

• Sample: curl http://127.0.0.1:5000/questions
  

    {
        "categories": {
            "1": "Science", 
            "2": "Art", 
            "3": "Geography", 
            "4": "History", 
            "5": "Entertainment", 
            "6": "Sports"
        },
        "current_category": "Science",
        "questions": [
          {
            "answer": "Blood",
            "category": 1,
            "difficulty": 4,
            "id": 22,
            "question": "Hematology is a branch of medicine involving the study of what?"
          },
          {
            "answer": "Alexander Fleming",
            "category": 1,
            "difficulty": 3,
            "id": 21,
            "question": "Who discovered penicillin?"
          },
          {
            "answer": "The Liver",
            "category": 1,
            "difficulty": 4,
            "id": 20,
            "question": "What is the heaviest organ in the human body?"
          },
          {
            "answer": "One",
            "category": 2,
            "difficulty": 4,
            "id": 18,
            "question": "How many paintings did Van Gogh sell in his lifetime?"
          },
          {
            "answer": "Escher",
            "category": 2,
            "difficulty": 1,
            "id": 16,
            "question": "Which Dutch graphic artist\u2013initials M C was a creator of optical illusions?"
          },
          {
            "answer": "Mona Lisa",
            "category": 2,
            "difficulty": 3,
            "id": 17,
            "question": "La Giaconda is better known as what?"
          },
          {
            "answer": "The Palace of Versailles",
            "category": 3,
            "difficulty": 3,
            "id": 14,
            "question": "In which royal palace would you find the Hall of Mirrors?"
          },
          {
            "answer": "Heres a new answer string",
            "category": 3,
            "difficulty": 1,
            "id": 24,
            "question": "Heres a new question string"
          },
          {
            "answer": "Lake Victoria",
            "category": 3,
            "difficulty": 2,
            "id": 13,
            "question": "What is the largest lake in Africa?"
          },
          {
            "answer": "Agra",
            "category": 3,
            "difficulty": 2,
            "id": 15,
            "question": "The Taj Mahal is located in which Indian city?"
          }
        ],
        "success": true,
        "total_questions": 20
    }
  

• General:

  • Deletes a question by id using url parameters.
  • Returns id of deleted question upon success.

• Sample: curl http://127.0.0.1:5000/questions/6 -X DELETE
  

    {
        "deleted": 11, 
        "success": true
    }
  

This endpoint either creates a new question or returns search results.

1. If no search term is included in request:

• General:

  • Creates a new question using JSON request parameters.
  • Returns JSON object with newly created question, as well as paginated questions.

• Sample: curl http://127.0.0.1:5000/questions -X POST -H "Content-Type: application/json" -d '{ "question": "Heres a new question string?", "answer": "Heres a new answer string", "difficulty": 1, "category": "5" }'
  

    {
      "success": true
    }
  

2. If search term is included in request:

• General:

  • Searches for questions using search term in JSON request parameters.
  • Returns JSON object with paginated matching questions.

• Sample: curl http://127.0.0.1:5000/questions -X POST -H "Content-Type: application/json" -d '{"searchTerm": "boxer"}'
  

    {
        "current_category": 4,
        "questions": [
            {
                "answer": "Muhammad Ali",
                "category": 4,
                "difficulty": 1,
                "id": 9,
                "question": "What boxer's original name is Cassius Clay?"
            }
        ],
        "success": true,
        "total_questions": 1
    }
  

• General:

  • Get questions by category id using url parameters.
  • Returns JSON object with paginated matching questions.

• Sample: curl http://127.0.0.1:5000/categories/6/questions
  

  {
    "current_category": "Sports", 
    "questions": [
      {
        "answer": "Brazil", 
        "category": 6, 
        "difficulty": 3, 
        "id": 10, 
        "question": "Which is the only team to play in every soccer World Cup tournament?"
      }, 
      {
        "answer": "Uruguay", 
        "category": 6, 
        "difficulty": 4, 
        "id": 11, 
        "question": "Which country won the first ever soccer World Cup in 1930?"
      }, 
      {
        "answer": "test A", 
        "category": 6, 
        "difficulty": 1, 
        "id": 25, 
        "question": "test Q"
      }
    ], 
    "success": true, 
    "total_questions": 20
  }
  

• General:

  • Allows users to play the quiz game.
  • Uses JSON request parameters of category and previous questions.
  • Returns JSON object with random question not among previous questions.

• Sample: curl http://127.0.0.1:5000/quizzes -X POST -H "Content-Type: application/json" -d '{"previous_questions": [16, 17, 18], "quiz_category": {"type": "Art", "id": "2"}}'
  

  {
      "question": {
          "answer": "One",
          "category": 2,
          "difficulty": 4,
          "id": 18,
          "question": "How many paintings did Van Gogh sell in his lifetime?"
      }
  }
  

Fisal Assubaieye authored the API (__init__.py), test unit (test_flaskr.py), and this README.
All other project files, including the models and frontend, were created by Udacity as a project template for the Full Stack Web Developer Nanodegree.