Skip to content

A slack bot to fetch all the ysws programs by hackclub for you.

License

Notifications You must be signed in to change notification settings

ikrishagarwal/ysws-bot

Repository files navigation

YSWS Bot

License: GPL v3 TypeScript Slack Bolt Status

A Slack bot to access HackClub's YSWS (Your Space With Support) programs right inside Slack β€” no need to switch between your browser and Slack!

Example of active ysws command

πŸš€ Features

  • πŸ“‹ View active, indefinite, inactive, and draft YSWS programs
  • πŸ”’ Paginated and numbered listings
  • ⚑ Brings the YSWS web UI into Slack for a seamless experience

πŸ› οΈ Built With

  • TypeScript
  • Slack Bolt
  • Node.js

πŸ“¦ Setup & Installationtion

  1. Install dependencies (don't forget to install pnpm)

    pnpm install
  2. Configure environment

    Copy the sample environment file and fill in your credentials:

    cp .env.sample .env
  3. Start the bot

    pnpm run dev

Note: Make sure to set up your Slack app and add the necessary permissions for the bot to function correctly. You can find the setup instructions in the Slack API documentation.

πŸ“Œ Usage

  • Interact with the bot using Slack slash commands.
  • Get a well-formatted, paginated list of YSWS programs directly in Slack.
  • Button actions for pagination and links to program resources.

πŸͺͺ License

This project is licensed under the GNU General Public License v3.0 (GPLv3).


Author: Krish (@ikrishagarwal)

About

A slack bot to fetch all the ysws programs by hackclub for you.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published