Unfortunately Neighborhood YSWS got cancelled - so this tool isn't useful anymore

A comprehensive Slack bot and web application for tracking Neighborhood YSWS database submission statuses with real-time notifications and AI-powered updates.

Or if you have any questions

▶️ Watch Demo Video if not loaded

• 🔄 Real-time Status Tracking: Automatically monitors submission status every 5 minutes
• 🔔 Instant Notifications: Slack DM notifications when status changes
• 🤖 AI-Powered Messages: Friendly, personalized status updates using AI
• 🌐 Web Dashboard: Beautiful web interface for status monitoring
• 📱 Dual Login: Support for both Slack OAuth and manual Slack ID entry
• ⚡ Live Updates: Real-time status checking with caching for performance
• 🎨 Modern UI: Responsive design with gradient backgrounds and smooth animations

• Backend: Python, Flask, Slack Bolt SDK
• Frontend: HTML5, CSS3, JavaScript (Vanilla)
• Scheduling: APScheduler for background tasks
• APIs: Slack Web API, Custom YSWS API
• Styling: Custom CSS with Tailwind-inspired utilities
• Icons: Font Awesome

• Python 3.8 or higher
• Slack workspace with bot permissions
• YSWS API access

git clone https://github.com/yourusername/NeighbourhoodStatus.git

cd NeighbourhoodStatus

pip install -r requirements.txt

Create a .env file in the root directory:

SLACK_BOT_TOKEN=xoxb-your-bot-token

SLACK_SIGNING_SECRET=your-signing-secret

SLACK_CLIENT_ID=your-client-id

SLACK_CLIENT_SECRET=your-client-secret

FLASK_SECRET_KEY=your-secret-key

python api.py

The application will be available at http://localhost:8721

• /yswsdb-track - Start tracking your submission status
• /yswsdb-status - Check your current status
• /yswsdb-untrack - Stop tracking notifications

1. Visit the web interface at your deployment URL
2. Login using either:
   • Slack OAuth: Secure authentication through Slack
   • Manual ID Entry: Enter your Slack User ID directly
3. View your dashboard with real-time status updates
4. Enable/disable tracking as needed

1. In Slack, click on your profile
2. Select "More" → "Copy member ID"
3. Use this ID for manual login

NeighbourhoodStatus/
├── api.py                 # Main Flask application
├── requirements.txt       # Python dependencies
├── tracked_users.json     # User tracking data (auto-generated)
├── .env                   # Environment variables (create this)
├── static/
│   └── style.css         # Custom CSS styles
├── templates/
│   ├── base.html         # Base template
│   ├── login.html        # Login page
│   └── dashboard.html    # User dashboard
└── README.md             # This file
 This file

1. Status Monitoring: The app checks the YSWS API every 5 minutes for status changes
2. Change Detection: Compares current status with last known status for each tracked user
3. AI Messages: Generates friendly status update messages using AI
4. Slack Notifications: Sends personalized DMs to users when their status changes
5. Web Dashboard: Provides real-time view of current status and tracking settings

1. Fork the repository
2. Create a feature branch: git checkout -b feature-name
3. Make your changes and commit: git commit -m "Add feature"
4. Push to the branch: git push origin feature-name
5. Submit a pull request

This project is licensed under the MIT License - see the LICENSE file for details.

• Bug Reports: Create an issue
• Feature Requests: Start a discussion

• Slack API for excellent documentation
• Flask for the web framework
• Font Awesome for beautiful icons
• Hack Club for the YSWS program