Braniac

Your favorite trivia-quiz competition place

Live site

Installation & Usage

Installation

• Clone repository
• cd into repository folder
• Run npm install and wait for installation
• if you would like to run the server side you need to run docker-compose up
  • you will find the server on the localhost:3000

Usage

• Run npm run dev and navigate to local server
• The client will be sending post request with the scores to netlify, in the next version, everything will run in a docker container

Technologies

Client Side

• React
• React-router
• Redux
• Webpack

Server Side

• Netlify functions
• MongoDB

Database

• MongoDB Atlas Cloud

Endpoints

Client

URL	Description
/	Home page with the initial formulary
/users	Show the add user modal
/:level/:category	Quiz game page that in case of not users start an anonynous game with 10 round
/scores/local	After game results
/scores/	Global scored that do a request to db

Server

Route Name	URL	HTTP Verb	Description
Show	/	GET	Get scores
Create	/	POST	Create a post

Changelog

Find the full changelog here

Future Features

• add the client to docker compose
• add Socket.io package
• add user profile img generator
• add auth an auth
• maybe theme background image by category

Licence

MIT Licence