QuizNose

Table of Contents

1. Project Description
   • About this Project
   • Problems this Application Solve
   • Current Version
   • High Level System Design
   • Built With
2. Getting Started
3. Contributing
4. Version History
5. Acknowledgements
6. Contact

About this Project

With QuizNose, you can smell the A+ from a mile away! QuizNose is an open source educational platform that allows for student teacher interaction with the goal to subject aptitude assessment for the modern classroom. Created with a microservice architecture, QuizNose can be scaled to meet consumer design. This will allow for higher volumes of traffic without worry of performance slow down as a monolithic application.

Problems this Application Solve

The application provides teachers insight on the performance of their students and has a granular view of the student’s understanding of a subject. By decoupling, we are able to ensure that the application is able to run smoothly and integrate any additional changes without drastically affecting other parts downstream.

High Level System Design

Image

Current Version

Stable version of QuizNose application that has unique user login, unique quiz sessions, and much more!

Built With

• Python
• Flask
• HTML
• CSS
• JavaScript
• Terraform
• Docker
• GitHub Actions
  
  

Getting Started

To get a local copy up and running follow these simple steps.

1. Clone the repository and change directories into it

   git clone https://github.com/Deodutt/QuizNose
   cd QuizNose/application/

2. Create a virtual environment and activate it. (Windows command)

    (Windows command)
    py -m venv venv
    .\venv\Scripts\activate
   
    (Deactivate using the following)
    deactivate

    (Linux command)
    pip3 install virtualenv
    virtualenv quiznose
    source ./quiznose/bin/activate
   
    (Deactivate using the following)
    deactivate

3. Install the required application dependencies

   cd application
   pip install -r requirements.txt

4. Run the flask application

    (Windows command)
    $env:FLASK_APP = "app.py"
    flask run
   
    (Linux command)
    export FLASK_APP=app.py
    flask run

5. Go to the local callback IP on your browser

   http://127.0.0.1:5000/

Note

1. If you are running this on Windows, make sure to comment out the socket function for get local ip. It's an issue that we have ran into on Windows, but works perfectly fine on Linux.

2. Make sure to create a secretstuff.py file referencing the proper variables to get the email function working.

   
   
   

Contributing

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

1. Fork this 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
   
   

Version History

• 1.0
  • Initial Release
    
    

Acknowledgements

• Vivekkairi - Application Template to Startup
• Will Campbell - Advice / Troubleshooting
• Tyrone Sanderson - Advice / Troubleshooting
• Sai Ho Yip - Troubleshooting
  
  

Contact

Ricardo Deodutt

Kenneth Tan

Kawang Wong

Dilobar Irisova