Skip to content

hack4impact/bootcamp-manager

Repository files navigation

Project Logo

H4I Bootcamp Manager

GitHub Workflow Status Code Style

A slack bot/web app for managing Hack4Impact bootcamps. Provides a convienient interface for H4I bootcampers to submit their assignments to bootcamp leaders. Uses MongoDB Atlas, Airtable, Node.js w/ typescript, and the Slack Bolt API.

Installation

  1. Clone the repository.
  2. Go to the project directory
  3. Run npm i

Usage

  1. Create a personal slack workspace for the development of this project
  2. Create an app in your workspace
  3. Retrieve the Slack Signing Secret and Slack API Token for your slack app
  4. Head to the "env" folder and create a file named .env
  5. Fill out the environment variables in ".env" as specified by ".env.example"
    1. Add a MongoDB Atlas URL
    2. Add your Airtable API key and base ID
    3. Add the Slack API secrets for your workspace
  6. Install ngrok
  7. Run npm run dev
  8. On another terminal run ngrok http 8080 or whatever port you specify in .env
  9. Go to your slack app settings and put https://yourNgrokUrl/slack/events as the URL for event subscriptions and interactivity
  10. Head to your app home in your slack workspace and you should see the app working!

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Subha Das

📖 💻 🤔

Benjamin Holmes

🤔 📆

This project follows the all-contributors specification. Contributions of any kind welcome!

Releases

No releases published

Packages

No packages published