@hackclub/bag
TypeScript icon, indicating that this package has built-in type declarations

3.0.1 • Public • Published

Bag

A whole RPG system within the Hack Club Slack!

Setup

To run locally, make sure you have the following installed:

  • Yarn
  • PostgreSQL: Either install it locally or set up a database in the cloud and get the database URL. More information at https://www.prisma.io/docs/concepts/database-connectors/postgresql. Your database URL should look something like postgres:://<user>@<location>/<db>, this is what DATABASE_URL is.
  • Set up a Slack app. More information at api.slack.com. You should have SLACK_SIGNING_SECRET, SLACK_APP_TOKEN (starts with xapp), and SLACK_BOT_TOKEN (starts with xoxb).

Once you have these, you'll need to git clone this repo, and then:

  1. yarn install && yarn run db:migrate-deploy
  2. Fill out .env.sample and rename it to .env.
  3. Add yourself to the the list of maintainers in maintainers.yaml.
  4. Run yarn dev!
  5. Start playing with the Slack bot! The first thing you should do is run /bot and create a app, and then add APP_ID and APP_KEY variables to your .env file.

/@hackclub/bag/

    Package Sidebar

    Install

    npm i @hackclub/bag

    Weekly Downloads

    15

    Version

    3.0.1

    License

    MIT

    Unpacked Size

    985 kB

    Total Files

    8

    Last publish

    Collaborators

    • recursiveforte
    • merlin04
    • josias_aurel_wing
    • jianmin-chen
    • archmaster
    • cfanoulis
    • lachlanjc
    • maxwofford
    • matthewstanciu
    • uanirudhx
    • sampoder