Skip to content

Latest commit

 

History

History
68 lines (55 loc) · 3.85 KB

README.md

File metadata and controls

68 lines (55 loc) · 3.85 KB
Raw

2024_fall Hackathon Project

Quick Links

Creator

team .exe (on Slack)

Team "team.exe"

Project Overview

Our project for Steam Superheroes focuses on automating processes, scaling operations, and building a matching system for mentors and mentees, with a fun, kid-focused twist around topics like STEAM, comics, and programming. We developed a sleek front end using Streamlit to display insights via Geckoboard, including user sign-ups, mentor reviews, generative AI feedback summaries, recent matches, and student progress metrics. Firebase serves as the database, with cloud functions enabling instant matching and data updates. Zapier and Twilio automate emails, SMS notifications, and scheduling through Gmail and Zoom, streamlining workflows and reducing manual tasks. By leveraging non-profit grants from providers like Google Cloud and Twilio, the solution stays cost-effective and scalable while providing seamless functionality for future growth.

Tech Stack

  • Frontend: Geckoboard, Streamlit
  • Backend: Python, JavaScript, Twilio, Zapier
  • Database: Firebase, Google Spreadsheets
  • APIs: Google Geocoding API

Getting Started

In IDE(like VS Code Editor), open new terminal and type: git clone https://github.com/2024-Arizona-Opportunity-Hack/team.exe-STEAMSuperheroes-STEAMSuperHeroesMentorshipPairingandSchedulingSystem.git cd 2024-Arizona-Opportunity-Hack/team.exe-STEAMSuperheroes-STEAMSuperHeroesMentorshipPairingandSchedulingSystem After changing to correct directory, install necessary dependencies by typing: npm install IMPORTANT! You might need to set up your own firebase project to run this locally and then configure your own firestore with cloud functions included. You might also needed google geocoding API key for files to work. For more help about Firebase and Google Geocoding API, refer here and here.

Run using: npm run dev

Your next steps

  1. ✅ Add everyone on your team to your GitHub repo like this video posted in our Slack channel
  2. ✅ Create your DevPost project like this video
  3. ✅ Use the 2024 DevPost to submit your project
  4. ✅ Your DevPost final submission demo video should be 4 minutes or less
  5. ✅ Review the judging criteria on DevPost

What should your final Readme look like?

Your readme should be a one-stop-shop for the judges to understand your project. It should include:

  • Team name
  • Team members
  • Slack channel
  • Problem statement
  • Tech stack
  • Link to your DevPost project
  • Link to your final demo video
  • Any other information you think is important

You'll use this repo as your resume in the future, so make it shine! 🌟

Examples of stellar readmes: