hackclub / awesome_hackclub_auto

🤖 Automation service for awesome-hackclub

awesome_hackclub_auto

Automation service for awesome-hackclub

Running locally

After installing Docker and Docker Compose, run docker-compose up in your favorite terminal.

Environment variables

Create a .env file, and stick the following env variables in:

SLACK_TOKEN=a slack bot token
SLACK_SIGNING_SECRET=signing secret, NOT verification token
REVIEW_CHANNEL=channel ID to post review messages to
AIRTABLE_API_KEY=airtable api key
AIRTABLE_BASE_ID=id of the airtable base
GH_APP_ID=id of github app
GH_INSTALLATION_ID=the installation id
HONEYBADGER_API_KEY=honeybadger api key (not required)

Commands

Command	Description
docker-compose up	Starts the dev environment locally
docker-compose up -d	Starts the dev environment, then detaches from the shell
docker-compose logs -f main	View logs from the main process
docker-compose down	Shut down the dev environment
docker-compose restart	Restarts the dev environment
docker ps	View running services

👥 Contributors

• @cjdenio

• @gleich

• @sampoder

awesome_hackclub_auto's Issues

Categories seem to be out of order sometimes

https://github.com/hackclub/awesome-hackclub/blob/db22bc1febf01ca5f1c826c62c14d5b8639b6789/README.md

"Browser Extensions" should be at the top. Airtable should be sorting it for us, but maybe we should sort the list locally after getting it from Airtable?

Slack verification

All Slack event endpoints must verify that the request actually came from Slack.

Don't allow reviewers to approve their own projects

Force update repo

Admin tool to force update the repo

Create production Dockerfile

Better logging

Store GitHub private key in env variable

For compatibility with CapRover, we'll have to base64-encode the GitHub private key, then feed it through an environment variable.

Categories

Project categories need to be implemented on the Slack side of things.

Should we have a set list of categories, or let users create new ones?

Home tab

Someday, Hack Clubbers might be able to browse projects inside of Slack, through the use of a home tab.

Push to repo

This app should be able to push to the README of the awesome-hackclub repo.

Remove unnecessary os.Exit() calls

We should only call os.Exit upon a critical, unrecoverable error (such as failure to connect to the database)

Admin tools

Deleting, renaming, the like

Project accept/deny functionality

The user should receive a DM letting them know when their project is accepted/denied. In the case of denial, they should be told why their project was denied.

Add basic Slack event receiving

With slack-go and mux, probably.

Switch to Airtable

While CouchDB is really cool, Hack Club already makes use of Airtable. Let's switch to that (shouldn't be too hard)

COMMENTS

yeah @cjdenio , write some comments

README.md generator