rodneygauna / kudotrio

HealthTrio Innovation Day

KudoTrio

HealthTrio Innovation Day - 2023 Q2

This project was created for the HealthTrio 2023 Q2 event.

Background

Kudos have come a long way since their humble beginnings as Post-It Notes for sharing shout-outs among colleagues. At HealthTrio, we understand the significance of fostering a culture of appreciation and engagement, and the Kudo program has played a vital role in achieving that.​

What started as a simple gesture of recognition has evolved into a rewarding program that celebrates the outstanding contributions of our employees. The Kudo Cards Slack channel has become a vibrant space filled with creative memes that bring a smile to everyone's face and amplify the impact of recognition.​

However, we believe there's always room for improvement. We have solicited feedback from our colleagues, who have expressed their desire for an even more streamlined and engaging Kudo experience.​

Today, we are thrilled to present our innovative solutions that address these needs and take the Kudo program to new heights.​

How To Run The Project

Important: Before starting you're own instance of this application, it is recommened to fork this GitHub project. Learn more about forking here: GitHub - Fork a repo

Summary to run this application:

1. Have Python (3.10 or higher installed)
2. Set up a Python Virtual Environment (optional but recommened)
3. Install the needed Python packages
4. Configure the email settings
5. Add the enviroment keys
6. Create the database
7. Run the app

Additional details for each step are below

Step 1: Python

In order to run the application, you'll need to have Python (version 3.10 or higher) installed on the host machine. You can download it here Python

Step 2: Python VENV (Optional but Recommended)

After installing Python, it's recommeneded to set up a virtual enviromnet. This ensures that all packages for the application are specific to this instance and will not cause any conflicts with other Python projects.

Follow these steps in the terminal:

1. Navigate outside the project folder (ensure you one directory above the 'KudoTrio' folder)
2. Type the following command: Windows: python -m venv KudoTrio\venv MacOS or Linux: python3 -m venv KudoTrio/venv

Once completed, you should see a direction/folder titled 'venv' as a sub-directory in the 'KudoTrio' folder.

Step 3: Python Packages

Once the Python virtual enviroment is set up, navigate into the 'KudoTrio' directory and follow these steps using the terminal:

1. Active your Python virtual environment with the following command: Windows - Command Prompt: venv\Scripts\activate.bat Windows - PowerShell: venv\Scripts\Activate.ps1 MacOS or Linux: source venv/bin/active
2. Using pip (Python's package installation manager), install the required packages using this command: Windows: pip install -r requirements.txt MacOS or Linux: pip3 install -r requirements.txt

Python will install all the packages and their appropriate versions from the requirements.txt file.

Step 4: Email Settings

Next, change the configuration of flask-mail settings in the __init__.py file. To do this, navigate and open the __init__.py file (HealthTrio/src/__init__.py).

Find the flask-mail configurations starting with the comment "# Mail configuration and initialization" (around line 50).

Update the information to reflect where outgoing emails should come from; such as the 'MAIL_SERVER', 'MAIL_PORT', etc.

Save the changes you've made.

Step 5: Enviroment Keys

After changing your email settings, create a new file in the parent directory ('KudoTrio') with the filename of .env.

Open the '.env' file and add the following:

SECRET_KEY=""
EMAIL_PASSWORD=""

The 'SECRET_KEY' is used by Flask for security and encryption of the forms when saving (POST) to the database.

The 'EMAIL_PASSWORD' is the password that's used to log into the email account you set up in step 5.

Here is an example of what your '.env' file could look like:

SECRET_KEY="this is a super secret string of letters and numbers 123456"
EMAIL_PASSWORD="password1234!"

Save the changes you've made.

Step 6: Create Database

Last step before running the app is to create and initialize the database. We are using SQLite3 for this project.

In the terminal, type the following command: flask commands create_db

You should see the following output: "Database created!"

This will create the database and tables for the application. You should find the database in the 'src' folder (KudoTrio/src/database.db).

Step 7: Run App

To run the app, type the following command in the terminal:

Windows: python app.py MacOS or Linux: python3 app.py

To stop running the application, press CTRL + C in the terminal.

CLI Commands

Using the following commands for testing and seeding the database with fake (using the PYthon package Faker):

• Drop the database: flask commands drop_db (Warning: this will destory and delete the database)
• Create the database: flask commands create_db
• Seed the database: flask commands seed_db

Credits

Meet Team High-Five Heroes!

• Nicole Naegeli
• Robert (Bob) Martin
• Rodney Gauna

Support

If you have any questions, you can do one of the following:

• Send an email to [email protected]
• Send an email to [email protected]
• Create an issue in the GitHub repo - guide here GitHub - Create an issue or pull request