Trivia is a web application that helps you manage creating funny quizzes by add different questions, with different difficulty levels, to different categories. You can manage it by manipulating questions by adding/modifying/deleting any questions from the database.
This project depends on Nodejs and Node Package Manager (NPM). Before continuing, you must download and install Node (the download includes NPM) from https://nodejs.com/en/download.
This project uses NPM to manage software dependencies. NPM Relies on the package.json file located in the frontend directory of this repository.
After cloning, open your terminal and run(Inside Frontend folder):
npm installtip: npm i is shorthand for npm install
Create a virtualenv and activate it
python3 -m virtualenv trivia_env
source trivia_env/bin/activatethen
pip install -r requirements.txtWith Postgres running, restore a database using the trivia.psql file provided. From the backend folder in terminal run:
createdb trivia
psql trivia < trivia.psqlFrom within the 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 runsh run_test.sh- GET
/categoriesfetches a dictionary of all available categories
curl -X GET http://127.0.0.1:5000/categories{
"categories": {
"1": "Science",
"2": "Art",
"3": "Geography",
"4": "History",
"5": "Entertainment",
"6": "Sports"
},
"success": true
}- GET
/questions?page=<page_number>fetches a paginated dictionary of questions
curl -X GET http://127.0.0.1:5000/questions?page=1{
"categories": {
"1": "Science",
"2": "Art",
"3": "Geography",
"4": "History",
"5": "Entertainment",
"6": "Sports"
},
"currentCategory": null,
"questions": [
{
"answer": "Maya Angelou",
"category": 4,
"difficulty": 2,
"id": 5,
"question": "Whose autobiography is entitled 'I Know Why the Caged Bird Sings'?"
},
{
"answer": "Muhammad Ali",
"category": 4,
"difficulty": 1,
"id": 9,
"question": "What boxer's original name is Cassius Clay?"
},
{
"answer": "Apollo 13",
"category": 5,
"difficulty": 4,
"id": 2,
"question": "What movie earned Tom Hanks his third straight Oscar nomination, in 1996?"
},
{
"answer": "Tom Cruise",
"category": 5,
"difficulty": 4,
"id": 4,
"question": "What actor did author Anne Rice first denounce, then praise in the role of her beloved Lestat?"
},
{
"answer": "Edward Scissorhands",
"category": 5,
"difficulty": 3,
"id": 6,
"question": "What was the title of the 1990 fantasy directed by Tim Burton about a young man with multi-bladed appendages?"
},
{
"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": "George Washington Carver",
"category": 4,
"difficulty": 2,
"id": 12,
"question": "Who invented Peanut Butter?"
},
{
"answer": "Lake Victoria",
"category": 3,
"difficulty": 2,
"id": 13,
"question": "What is the largest lake in Africa?"
},
{
"answer": "The Palace of Versailles",
"category": 3,
"difficulty": 3,
"id": 14,
"question": "In which royal palace would you find the Hall of Mirrors?"
}
],
"success": true,
"total_questions": 19
}- DELETE
/questions/<question_id>Deletes an existing questions from the database
curl -X DELETE http://127.0.0.1:5000/questions/14{
"deleted": 14,
"success": true
}- POST
/questionsAdds a new question to the database
$ curl -X POST -H "Content-Type: application/json" -d '{"question" :"QuestionSample?", "answer":"AnswerSample!", "difficulty":"1", "category":"1"}' http://127.0.0.1:5000/questions{
"created": 24,
"success": true,
"total_questions": 19
}- POST
/questions/searchFetches all questions where containing a substring of the search-term (non-case-sensitive)
curl -X POST -H "Content-Type: application/json" -d '{"searchTerm" :"title"}' http://127.0.0.1:5000/questions{
"questions": [
{
"answer": "Maya Angelou",
"category": 4,
"difficulty": 2,
"id": 5,
"question": "Whose autobiography is entitled 'I Know Why the Caged Bird Sings'?"
},
{
"answer": "Edward Scissorhands",
"category": 5,
"difficulty": 3,
"id": 6,
"question": "What was the title of the 1990 fantasy directed by Tim Burton about a young man with multi-bladed appendages?"
}
],
"success": true,
"total_questions": 2
}- GET
/categories/<int:category_id>/questionsfetches all questions for the specified category
curl -X GET http://127.0.0.1:5000/categories/1/questions{
"current_category": 1,
"questions": [
{
"answer": "The Liver",
"category": 1,
"difficulty": 4,
"id": 20,
"question": "What is the heaviest organ in the human body?"
},
{
"answer": "Alexander Fleming",
"category": 1,
"difficulty": 3,
"id": 21,
"question": "Who discovered penicillin?"
},
{
"answer": "Blood",
"category": 1,
"difficulty": 4,
"id": 22,
"question": "Hematology is a branch of medicine involving the study of what?"
},
{
"answer": "AnswerSample!",
"category": 1,
"difficulty": 1,
"id": 24,
"question": "QuestionSample?"
}
],
"success": true,
"total_questions": 4
}- POST
/quizzesfetches random question of the specified category, and this question is guaranteed to be a new one not of the prvious questions.
curl -X POST -H "Content-Type: application/json" -d '{"previous_questions": [11, 12, 13], "quiz_category": {"type": "Art", "id": "2"}}' http://127.0.0.1:5000/quizzes{
"question": {
"answer": "One",
"category": 2,
"difficulty": 4,
"id": 18,
"question": "How many paintings did Van Gogh sell in his lifetime?"
},
"success": true
}