NoBrainerQuiz / web

Web application for NoBrainer
0 stars 0 forks source link

Build Status Build Status Code Intelligence


NoBrainer

NoBrainer is an online real-time quiz application written in PHP & NodeJS. It's built with Laravel & Socket.io.

It's goal is to be:

System Requirements

NoBrainer is currently in development, so please expect bugs and potential unexpected behaviour.

Once you have successfully installed all of NoBrainer's dependencies you can move on to the installation steps.

Installation

Clone the repository to your local machine

$ git clone https://github.com/NoBrainerQuiz/web.git NoBrainer
$ cd NoBrainer

Create .env and enter details

$ cp .env.example .env

Install dependencies

$ composer install && npm install

Run migrations, seed database and starting the server

$ php artisan migrate
$ php artisan db:seed

If using the laravel server run

$ php artisan serve

**Configure MySQL***

Download a MySQL server.
Make the database by doing: create database nobrainer;

Setting up your .env file and MySQL

Make sure all of the settings are the same in your file:

BROADCAST_DRIVER=redis

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=nobrainer
DB_USERNAME=<username you made when installing MySQL>
DB_PASSWORD=<password you made when installing MySQL>

Open the file /app/Sockets/database.js and set the username and password for the MySQL to the same as above.

Starting Sockets and Redis (Redis needs installing beforehand)

$ redis-server
$ node socket

Go to http://127.0.0.1:8000/pin and enter 9876, then enter your desired username.

Then to start the quiz go to http://127.0.0.1:8000/quiz/start/9876 (on a seperate browser)

Brief Installation video by UP805717: https://youtu.be/rxy6xUXWi68 (Youtube Link)

Development Team

Name Role
Kent55 - UP821309 Core Development
springjben - UP805717 Core Development
GlennHS - UP824726 UI Development
jamesdavy21 - UP804392 Mobile Development