full-stack-library

Authors:

• Matthew Rizzo - [email protected]
• Nicholas Rizzo - [email protected]
• Domenic Privitera - [email protected]

For a full explanation & demo, please read the docs

To see a live demo please access the deployed webapp here. If the page is down please contact one of the authors for support!

Creating and Running the Project

• libraries - see install/requirements.txt
  • However, existing scripts will handle the installation / setup of these libraries (assuming you can run the install/setup.sh or install/setup.bat files)
  • Feel free to look at the list within the text file
• Software
  • MySQLWorkbench + MySQLServer
    • Used as in class, to create the schema using the complete dump file
  • Python version 3.9 (python3.9)
    • Download Page: https://www.python.org/downloads/release/python-390/
    • Please select the option at the bottom of the page that matches your Operating System

Setup Steps:

1. (For Windows Only) Download Python3.9
   1. Note: Using a different / earlier version of python will result in the code not working. Please be sure your version is python 3.9.
   2. Please run py -0 to see a list of installed python versions.
      1. Please confirm that you see "-3.9-64 *" or "-3.9-64 ". If not, the installation was not successful.
   3. If you are using Ubuntu or a Debian distribution, this install will be handled for you in install/setup.sh.
2. Run the library database sql setup script found at src/database/library_db_sql.sql
3. Run setup scripts. Pick the correct one based on your operating system:
   • Windows: install/setup.bat
     • Note: this can be done through command prompt OR just double clicking on the file in File Explorer
   • Ubuntu/Debian/Windows Git-Bash: install/setup.sh
   • This handles the complete setup of a virtual environment with the correct libraries/packages for the project.
   • The virtual environment will live in /library-venv relative to the top level of this project
   • Depending on the operating system, the exact location of the python interpreter will change. However, the start scripts will handle that, and you do not need to figure it out.
4. If testing the late fee calculation functionality:
   • After running the dump file to create the schema, please run the sql script at /src/database/show_overdue_functionality.sql.
   • The script adds another procedure to the database which can checkout a book on a specific day.
     • It then checks out a book on a specific day in the past with a very low checkout length.
     • The book is checked out by user nickrizzo.
   • This is added as an additional feature because the group believed the existence of a procedure to checkout a book on a specific day was inappropriate.
     • The design of the application is such that a user checks out a book the moment they are checking it out.
     • There should NOT be an interface by which they can checkout a book on a different day.
     • Hence, this procedure could not be included in the main dump file.
     • However, for the ease of validating that our late fee calculation is correct,
       • the group added the procedure in this limited capacity.
   • If the steps in View Profile user flow are followed for the nickrizzo user,
     • the late fee will be displayed in the table and can be verified.

Running / Starting the Application Server:

1. Windows: start.bat
   1. Note: this can be done through command prompt OR just double clicking on the file in File Explorer
   2. The application can also be started by clicking on the file itself in the file explorer.
2. Ubuntu/Debian/Windows Git-Bash: start.sh
3. Each script will call main.py using the python virtual environment setup.
4. Open the landing page to begin interacting with the Frontend / client side
   1. http://localhost:8080/
   2. When the server starts it will also print this url in case port 8080 is taken
5. NOTE On Windows:
   1. The first time the program is run, Windows Firewall might block the application, please click "Allow Access". This issue should not happen again.
   2. When ending the program please do Ctrl+C then respond to Terminate batch job (Y/N)? with y and click enter.