Skip to content

Trivia App is a website built by a restful API, which permits you to create questions, see different categories and questions, and play a quiz to test your knowledge. This FullStack project demonstrates my knowledge in building REST APIs with flask.

Notifications You must be signed in to change notification settings

younesaitmha/trivia-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Trivia App

Introduction

Trivia App is a website built by a restful API, which permits you to create questions, see different categories and questions, and play a quiz to test your knowledge.
Game mechanism: Currently, when a user plays the game they play up to five questions of the chosen category. If there are fewer than five questions in a category, the game will end when there are no more questions in that category.
This FullStack project demonstrates my knowledge in building REST APIs with Flask.

Starting the project

  1. Clone the repository to your laptop.
  2. From the backend directory, create a virtual environment, install requirements and set the required environment variables or check out the backend documentation here.
  3. Start the backend server by running python run.py
  4. Run another terminal session. In the frontend directory, run npm install to install the required dependencies.
  5. Finally, start the frontend server by running npm start
  6. You can view the website by visiting or clicking http://localhost:3000 in your browser.

For more information about how to get up and running, consult the following documents:

About the Stack

the backend is a server backed with Flask and SQLAlchemy. The frontend created using react and jquery/ajax. The two servers communicate using a REST api.

How To Contribute?

  • clone the project
  • create a new branch
  • open a pull request with only the changed files
  • Suggestions
    1. Add an additional question field such as rating and make all corresponding updates (db, api endpoints, add question form, etc.)
    2. INTENSE: Add users to the DB and track their game scores
    3. Add capability to create new categories.

About

Trivia App is a website built by a restful API, which permits you to create questions, see different categories and questions, and play a quiz to test your knowledge. This FullStack project demonstrates my knowledge in building REST APIs with flask.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published