haroon/hack-club-eligiblity
1
0
Fork 0
Code Issues Pull requests 4 Projects Releases Packages Wiki Activity Actions
No description
10 commits 5 branches 0 tags 566 KiB
TypeScript 100%
Find a file
Renovate Bot f3c1213598
Update dependency typescript to v5.6.3
2024-10-19 05:12:12 +00:00
.gitignore change whitelist to work with a JSON file 2024-09-05 17:07:28 +01:00
index.ts change whitelist to work with a JSON file 2024-09-05 17:07:28 +01:00
package-lock.json Update dependency typescript to v5.6.3 2024-10-19 05:12:12 +00:00
package.json add different states + only allow viewing of other if whitelisted 2024-09-04 17:16:01 +01:00
README.md change whitelist to work with a JSON file 2024-09-05 17:07:28 +01:00
renovate.json Add renovate.json 2024-09-04 00:18:35 +01:00
tsconfig.json Hack Club Eligibility Bot™️ 2024-09-04 00:12:02 +01:00
whitelist.example.json change whitelist to work with a JSON file 2024-09-05 17:07:28 +01:00

README.md

Hack Club Eligiblity Bot

A bot that allows you to view the eligiblity of someone in Hack Club for certain swag (basically "are you a student?")

This uses the Hack Club Eligiblity API (duh).

Usage

Run /check-eligiblity in any Slack channel, and optionally ping a user to check their eligiblity (otherwise it shows your own).

If you view your own eligiblity, you can also see the raw response from the API.

Installation

  1. Clone the repo.
$ git clone https://git.hackclub.app/haroon/hack-club-eligiblity.git
  1. Enter the newly created directory.
$ cd hack-club-eligiblity
  1. Add your bot token and signing secret to .env:
$ <editor> .env

# Add:
SLACK_BOT_TOKEN=<>
SLACK_SIGNING_SECRET=<>
  1. Install dependencies:
$ npm i
  1. Run!
$ npx tsx .
  1. (Optional) Rename whitelist.example.json to whitelist.json and fill it with Slack User IDs who apart from admins/owners/primary owners should be able to view other people's verification.
[
    "UA1B2C3D4E5",
    "U0123456789"
]