Skip to content

Latest commit

 

History

History
127 lines (85 loc) · 4.7 KB

README.md

File metadata and controls

127 lines (85 loc) · 4.7 KB
Raw

TRIVIA API

Trivia API Backend

This is a fullstack web app backend. Read through the backend documentation to install its dependencies.

Backend - Trivia API

Setting up the Backend

Install Dependencies

  1. Python 3.7 and PIP- Follow instructions to install the latest version of python for your platform in the python docs

  2. Virtual Environment - It's recommended to leverage 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

If you have pip virtualenv already installed; create a siloed python environment. Run in your backend directory:

python -m virtualenv venv

To activate virtual venv on Windows run:

venv\Scripts\activate

The equivalent command on UNIX-based operating systems run:

source venv/bin/activate
  1. PIP Dependencies - Once your virtual environment is setup and running, install the required dependencies by navigating to the /backend directory and running:
pip install -r requirements.txt

Key Pip Dependencies

  • Flask is a lightweight backend microservices framework. Flask is required to handle requests and responses.

  • SQLAlchemy is the Python SQL toolkit and ORM we'll use to handle the lightweight SQL database. You'll primarily work in __init__.pyand can reference models.py.

  • Flask-CORS is the extension we'll use to handle cross-origin requests from our frontend server.

Set up the Database

With Postgres running, create a trivia database:

createdb trivia

The analogous command for Windows environment:

create database trivia;

Populate the database using the trivia.psql file provided. From the backend folder in terminal run:

psql trivia < trivia.psql

The equivalent dump in Windows is:

psql -U username trivia < trivia.psql

Run the Server

From within the root backend directory and with activated virtual environment...

To run the server, execute:

set FLASK_APP=flaskr
set FLASK_ENV=development
flask run

The analogous commands for UNIX based systems are:

export FLASK_APP=flaskr
export FLASK_ENV=development
flask run --reload

The --reload flag will detect file changes and restart the server automatically.

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

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.

  1. Use Flask-CORS to enable cross-domain requests and set response headers.
  2. 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.
  3. Create an endpoint to handle GET requests for all available categories.
  4. Create an endpoint to DELETE a question using a question ID.
  5. Create an endpoint to POST a new question, which will require the question and answer text, category, and difficulty score.
  6. Create a GET endpoint to get questions based on category.
  7. 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.
  8. Create a POST endpoint to get questions to play the quiz. This endpoint should take a 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.
  9. Create error handlers for all expected errors including 400, 404, 422, and 500.

Documenting API Endpoints

Provided detailed documentation and reference of the API endpoints including the URL, request parameters, and the response body are in the API documentation reference README markdown file in the root directory of the TRIVIA API app.

View Trivia API Documentation and API Reference for sample requests and responses and endpoints behavior.