Skip to content

ECE444-2023Fall/Blue-Surf

Repository files navigation


Logo

BlueSurf

Your one-stop destination for seamless event discovery, connecting UofT students, clubs, and design teams to create vibrant campus experiences.
View Demo · Report Bug · Request Feature . Project Management

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. License
  5. Contact
  6. Acknowledgments

About The Project

Check out the demo video below! Watch the video

Ride the Wave with Blue Surf!

Welcome to Blue Surf, your ultimate campus companion for all things University of Toronto (UofT). Our mission? To transform your campus life into a thrilling journey of discovery, connection, and endless opportunities!

🏄‍♂️ Seamless Event Discovery: With Blue Surf, effortlessly catch the wave of exciting campus events. Say goodbye to lost flyers and missed opportunities!

🌊 One-Stop Campus Hub: Our user-friendly platform lets you post, explore, and engage with events - no need to surf the web, bulletin boards, or social media!

📣 Amplify Your Voice: Whether you're a club leader, an individual with a message, or a student seeking the next big thing, Blue Surf is your megaphone. Share announcements, recruit for your club, or discover the coolest events with ease.

🤙 Join the Blue Surf Community: Let's ride this wave together and create a vibrant, connected campus life. Blue Surf is all about making your university experience unforgettable!

So, grab your virtual surfboard and get ready for an exciting ride with Blue Surf. We're here to make waves and can't wait for you to dive in!

(back to top)

Built With

  • Flask
  • React
  • Bootstrap
  • Postgres

(back to top)

Epics and User Stories

BlueSurf Presentation GIF

Roadmap

List of features currently under development by categories 🛠

  • Searching for Posts
    • Search by keywords
    • Search by club name
  • Filtering and Sorting
    • Filter posts with the use of tags
    • Filter posts by date and time
    • Filter posts by location
    • Filter posts by club
    • Sort posts alphabetically
    • Sort posts by date
    • Sort posts by trending
  • Creating Posts
    • Input information to create a post
    • Preview post before publishing
  • Managing Posts
    • Automatically take down a post after a given expiry date
    • Individual to be able to edit their post after it has been posted
    • Delete a post
  • Interacting with Posts
    • View how many users are interested in an event (I.e., to provide an estimate if how many people will join the event).
  • Personal Dashboards:
    • View events without having to sign in/create login in page.
    • View posts you liked
    • View posts you created
  • Integrations and Notifications:
    • Export favourite events to Apple Calendar
    • Export favourite events to Google Calendar
    • Allow users to subscribe to clubs and events
    • Get email notifications for upcoming events

See the open issues for a full list of proposed features (and known issues).

(back to top)

Getting Started

Open in Visual Studio Code

These instructions will help you get your project up and running on your local machine!

Prerequisites

After creating and activating a virtual environment, run the following command to install all the dependencies:

  • pip
    pip install -r requirements.txt

Create a file named .env in the root directory and add the following content there:

  • env
    export SECRET_KEY=fdkjshfhjsdfdskfdsfdcbsjdkfdsdf 
    export DEBUG=True 
    export APP_SETTINGS=config.DevelopmentConfig 
    export DATABASE_URL=sqlite:///db.sqlite 
    export FLASK_APP=src 
    export FLASK_DEBUG=1 
    export SECURITY_PASSWORD_SALT=fkslkfsdlkfnsdfnsfd 
    export EMAIL_USER=your-email 
    export EMAIL_PASSWORD=your-password 

Run the following command to export all the environment variables from the .env file:

  • source
    source .env 

Run the following commands to set up the database:

  • flask
    flask db init 
    flask db upgrade

Run the following command to run the Flask server:

  • python
    python manage.py run 

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact Us

Project Link: https://github.com/ECE444-2023Fall/Blue-Surf

The Team

(back to top)

Acknowledgments

(back to top)