Skip to content

ECE444-2023Fall/beaver-buzz

Repository files navigation

BeaverBuzz by Premium Potatoes

CI frontend-format frontend-tests Pylint Taurus

About

BeaverBuzz is a community-based event-sharing platform that enables clubs and organizers to post events and reach out to the University of Toronto (UofT) student community. It also allows UofT students to explore new communities and discover new interests and activities. This app aims to create a better-connected student body at UofT and provide access to a range of extracurricular activities.

How to Use this Repo

  • Pull the Repo: use git clone
  • Set up the virtual environment using the following steps
    1. cd api/
    2. pip install virtualenv
    3. virtualenv venv
    4. source venv/bin/activate (for windows, use the following command: .\venv\Scripts\activate)
    5. pip install -r requirements.txt
  • You will need to install yarn to run the apps: Yarn (you may need to install npm to install yarn)
  • To run the Frontend React App (the React app uses App.js to show the frontend):
  • To run Backend Flask App (the flask app uses api.py to display the backend and interact with the database):
    • Enter your virtual environment: source venv/bin/activate (for windows, use the following command: .\venv\Scripts\activate)
    • Then use yarn start-api to run
    • This will open at http://localhost:8000/ (if that doesn't work, try http://127.0.0.1:8000/)
  • To deploy to Heroku:
    • Make sure you have the Heroku CLI installed: Heroku CLI
    • git push heroku git subtree split --prefix api steven_dev:refs/heads/master --force
      • Replace steven_dev with the branch you wish to deploy
    • git push frontend main:main

Features

  • Event information: date, time, location, additional details, flyer, comment section
  • Events discovery: see events users with similar interests have RSVPed and trending events
  • Search: by event name, organizer, category, and time
  • Subcriptions: users can subscribe to organizers
  • User information: users can see the list of their registered events, subscribed organizers, categories on their profile
  • Notifications: choice of email or push notifications prior to events

Built With

  • React
  • Flask
  • PostgreSQL
  • Heroku
  • Nginxx
  • docker

Roadmap

Premium Potatoes utilize Jira Software for project management which can be accessed: jira or here.

Contact

Premium Potatoes Github: Github