Skip to content

Latest commit

 

History

History
87 lines (50 loc) · 2.89 KB

README.md

File metadata and controls

87 lines (50 loc) · 2.89 KB
Raw

Log Keeper

661 VGS - All-in-one log keeper for the Viking fleet. Records launches from 2965D log sheets, uploads to MongoDB Atlas, and provides a web interface for viewing statistics.

image

Contents

  1. Installation
  2. Usage
  3. Contribution
  4. Testing
  5. Support
  6. License

Installation

  1. Sync your squadron sharepoint using OneDrive:

    image

  2. Create a directory on your sharepoint to store the log sheets e.g. Log Sheets.

  3. Save the 2965D_YYMMDD_ZEXXX.xlsx template (See docs/) into the Log Sheets directory.

    image

  4. Get started with creating some log sheets to test it out. Note, you will need to update the hidden INPUT_DATA sheet to add your aircraft and pilots:

    image

  5. Sign up to MongoDB Atlas. Contact the project owner for access to the database.

Usage

Normal Usage

  1. Login to the dashboard:

    Dashboard login

  2. Upload your completed log sheets. Note, the re-uploading log sheets will overwrite the existing data:

    Upload page

Python Dashboard

  1. The log keeper comes with a python dashboard for viewing statistics. To run the dashboard, setup the secrets. NOTE, you must have a MongoDB Atlas account and access to the database (get this from the project owner).:

    echo "MONGO_URI=<YOUR_MONGO_URI>" > .streamlit/secrets.toml

  2. run the following command:

    viking-dashboard

    image

Contribution

image

Testing

To run the tests, run the following commands:

playwright install
python -m pytest

Support

For questions and assistance, consider raising an issue on the issue tracker. All other queries can be directed to mjennings061@gmail.com

License

The project is licensed under the MIT License.