Skip to content

ej8899/companyQuiz

Repository files navigation


Logo

CompanyQuiz!

Test your Employees on their knowledge of company policy and received detailed and summary reports! CompanyQuiz! is built as a full SaaS application demo with landing page, admin pages and user pages.

Explore the docs »

View Live Demo . Report Bug . Request Feature

Downloads Contributors Issues License Commits

Table Of Contents

About The Project

Sample quiz

CompanyQuiz! is intended to allow your company to deploy simple quizzes and exams to your staff to test their knowledge on various company policy and proeedures.

End User Admin A simple end user interface allows your staff to select the policy or area of testing.

Sample quiz A more robust backend allows administrators to review all users quiz results and status, create new quizzes, and add new users for testing. A summary is also displayed so you can see your company compliance stats at a glance.

Built With

Built with React, MySQL and PHP.

Installation

  1. You'll need a couple of API keys if rolling your own deployment. You'll need a key for UnSplash images and for OpenAI..

  2. Clone the repo

git clone git@github.com:ej8899/companyQuiz.git
  1. Install NPM packages
npm install
  1. Enter your database and api keys in config.php
<?php
  $servername = "localhost";
  $username = "";
  $password = "";
  $database = "";

  $unsplashkey= "-";

  $openai_api_key = "sk-";
  $openai_url = "https://api.openai.com/v1/chat/completions";
  $openai_model = "gpt-3.5-turbo";
?>

Usage

If using the existing live demo site, you can login under admin@acmecorp.com for the company administrator and wcabot@example.com as an end user/company employee. No password is required for either of those demo accounts as destructive features are disabled for the demo accounts.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  • If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
  • Please make sure you check your spelling and grammar.
  • Create individual PR for each suggestion.
  • Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Authors

Acknowledgements