Skip to content

joelclouds/EmployeeOnboardingSystem

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Employee Onboarding System

A cross-platform desktop utility for automated batch employee onboarding via Google Workspace. Installs directly to your system application menu (Start Menu on Windows, Application Grid on Linux) for seamless access.

📧 Contact: joelclouds@gmail.com 🔗 Repository: github.com/joelclouds/EmployeeOnboardingSystem
🌍 Platform: Windows & Linux


🚀 Quick Start: Install Dependencies

Before cloning the repository, ensure your system has Python 3.10+ and Git installed.

🪟 Windows

  1. Install Git: Download from git-scm.com.
  2. Install Python: Download Python 3.10+ from python.org.
    • ⚠️ Critical: Check "Add Python to PATH" during installation.
  3. Verify: Open Command Prompt (cmd) and run:
    python --version
    git --version

🐧 Linux (Debian/Ubuntu)

Run this single command to install all required system dependecies:

sudo apt update && sudo apt install -y python3-full git

📥 Installation & Management

Clone the repository first:

git clone https://github.com/joelclouds/EmployeeOnboardingSystem.git
cd EmployeeOnboardingSystem

1. Fresh Install

Installs dependencies and registers the app in your system menu.

  • Windows: python setup.py --fresh
  • Linux: python3 setup.py --fresh
    • Look for "Employee Onboarding System" in your Start Menu or App Grid.

2. App Update

Pulls latest code and updates dependencies while preserving your menu shortcut.

  • Windows:
    git pull
    python setup.py
  • Linux:
    git pull
    python3 setup.py

3. Uninstallation

Removes dependencies, deletes the system menu shortcut, and cleans the project folder.

  • Windows:
    python setup.py --uninstall
    cd ..
    rmdir /s /q EmployeeOnboardingSystem
  • Linux:
    python3 setup.py --uninstall
    cd ..
    rm -rf EmployeeOnboardingSystem

4. Manual Run (Optional)

Run without installing to the menu (for debugging):

  • Windows: python -m src.ui.app
  • Linux: python3 -m src.ui.app

🔐 First Run Configuration

  1. Launch the app from your System Application Menu (or via CLI).
  2. Click ☰ Show Settings.
  3. Enter your EMPLOYEE_GOOGLE_SHEET_URL and verify column headers.
  4. Click 💾 Save & Apply (triggers live validation).
  5. Click 🚀 Start Batch Onboarding.
    • A browser window will open for Google OAuth authentication.
    • Grant permissions to generate token.pickle.

🛠️ Troubleshooting

Issue Solution
App not in Menu Run setup.py again; ensure no errors occurred during execution.
setup.py fails Update pip: python -m pip install --upgrade pip
tkinter missing (Linux) Install via: sudo apt install python3-tk
OAuth / Token Error Delete token.pickle in the project root to re-authenticate.
Sheet Validation Failed Verify the Google Sheet is shared with the service account email.

📬 Support

For issues, feature requests, or enterprise licensing: Email: joelclouds@gmail.com Please include: Operating System, Python version, and the full error traceback.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages