Lin Trieu, Quiz Manager Application

Technology Stack

• PHP v8.1.2
• Laravel Framework v8.x
• Composer, Dependency Manager
• mySQL Database
• Eloquent, Database ORM
• HTML, Blade templates
• CSS, Bootstrap library
• JavaScript, jQuery library

---

Quiz Manager README

Project Context

• Client: A software company that provides on-line educational solutions for education establishments and training providers.
• Brief: design, build, and test a database-driven website to manage quizzes, each consisting of a set of multiple-choice questions and their associated answers.

User Account Login Details for Testing

The application is pre-configured with three user accounts for each of the user permission levels.

Login Details:

• Email: restricted@test.com
• Email: view@test.com
• Email: edit@test.com

Password for all user accounts: password

---

How to set up & run application for local development

For full guidance, refer to file 2.2. Quiz Manager Setup Instructions

1. Git clone the GitHub repository

2. Install

   • PHP
   • mySQL
   • Composer
   • Node.js and NPM
   • Makefile

3. Create a .env file to contain sensitive credentials as environment variables (see .env.example file as an example)

   • In the root of your project, run php artisan key:generate and php artisan config:cache to generate an application key for your application (APP_KEY in .env file))

4. Compile CSS UI resources by running npm install, and build dev assets running npm run dev,

5. Set up a local mySQL database named quiz-manager (details below)

6. Run the command make migrate-seed to run database migrations and seeders

7. Run make start to start the server. View application on your localhost.

See Makefile for a list of commands available in the application.

Create a local mySQL database

1. Install the mySQL client,

2. Run the mySQL client - $ mysql -u root -p

   • root - user
   • p - you will be prompted to enter your mysql root user password. Please enter when you have input your password.

3. Create a local database the application can integrate with: CREATE DATABASE quiz_manager;

   • Run the query SHOW DATABASES;, to confirm your database has been created.

4. In the Quiz Manager .env file (line 9-15), please check the Database Connection config matches the details you configured locally.

   • DB_CONNECTION, DB_HOST, DB_PORT - you should not have to update these
   • DB_DATABASE - update with the name of your Database (e.g. quiz_manager)
   • DB_USERNAME, DB_PASSWORD - represent your personal mySQL user credentials

5. Once your .env config is set up, run make migrate to confirm your Database connection is working as expected.

---

Screenshots of the Application's User Interface (UI)

User Login page

All Quizzes: homepage

Quiz example

Editing a Question in a Quiz

Adding a new Question to a Quiz

---