Skip to content

A real-time webapp that combats loneliness and anxiety in social scenarios through digitally facilitated introductions, based around preferred topics of conversation.

Notifications You must be signed in to change notification settings

simonayzman/Icebreaker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Icebreaker

Inspiration

Meet Jonah. An introverted, moderately quiet person between the ages of 18 - 35 years old. Jonah has a lot of interests and has had many unique experiences that make him a fascinating person to talk to. However, he doesn't often get the chance to truly share his interests, likes, and personality in social settings. When he finds those one or two people who he can deeply connect with at a party, his night is made! But finding those people means anxiety and stress. Sometimes, it doesn't seem worth it, so he avoids going places altogether.

Whether it’s your first day of school, a work conference, or your friend’s house party, there’s no shortage of ways to improve the experience of fostering connections. Icebreakers can be effective, but they’re often in large groups, which can be impersonal and overwhelming. Too much time and anxiety is spent on finding the right people to talk to and the right topic to talk about. A digital medium could facilitate these in-real-life encounters to great effect.

Introducing, Icebreaker™ - the easy way to break the ice and make better connections. Inspired by the wonderful multiplayer experiences of Jackbox Games and Spyfall, Icebreaker fosters deeper IRL connections between people, based around the topics they'd like to talk about and the questions they’d love to delve into together.

How does it work?

Let's say you're planning a low-key party at your house. Not everyone will know each other there, so you turn to Icebreaker™ to ease the anxiety of people getting to know each other. You come to the website, and create a shared event "room." Icebreaker autogenerates a unique 6-character room code for you. As guests start trickling into your home, you share the room code with them.

Now let's switch our perspective to you as a guest. You get to the party, and the host shares the room code with you. You come to the site, enter the code (along with some identifying information), and then get whisked into the core of the digital experience.

First, you see a "Tinder" like experience, except instead of swiping on people, you're swiping on questions and topics. In other words, would you want to answer these questions or talk about these topics with someone else in a 1:1 conversation? If yes, swipe right! If no, swipe left! Really love it? Swipe up for a super like! Don't really care one way or another? Swipe down.

Once you're finished swiping, you enter the "digital room." You'll see a list of all the people at the party, ordered by how closely they match with you over your preferred questions and topics of conversation! Moreover, this list updates in real time, meaning that as new people join the party, you might find an even better top-ranked match later into the night. You can click into a person's profile from the list, and see specifically what you two can bond over.

What happens next is up to you! You choose who to talk to and what to talk to about. Happy friendshipping!

Demo Video

Watch a full demo of the experience here!

Technologies Used

The front-end is built with React and connects to a Flask (Python-based) back-end hosted on Heroku. Data is stored in a Firebase real-time database, specifically Firestore. The real-time connection is maintained via Socket.IO.

Development Quick Start

Unfortunately, it's not possible to run the app locally without a connection to a live Firebase database; the server will not function properly without it. The necessary keys/credentials are provided via a hidden, non-committed file server/keys.json for local runtimes and provided as environment variables in the production instance on Heroku. The website used to be hosted at http://deep-dive-072193.herokuapp.com/, but is no longer.

However, assuming all of the credentials exist, a normal development flow looks like:

pipenv shell    # Activate python virtual environment and install pip dependencies
./dev.sh        # Start backend Flask server

In a separate terminal window:

cd client       # Jump to frontend/client code directory
npm install     # Install npm dependencies for frontend
npm start       # Start frontend server for local React bundle

If changes are made to the frontend code and they are ready for release, build the React production bundle (script below). However, make sure to commit it to the git repository afterwards, too, so that Heroku actually picks up the changes. This process can be automated in the future as simply a step in the CI/CD pipeline.

# Run within client/
npm run build   # Updates 'client/build' directory with production React bundle

To run tests:

# Run at top-level directory
./test.sh

You could join room AAAAAA to go through the entire flow of the application as a user. If you're hosting an event yourself, try creating a room and sharing its code with your guests!

Project Structure

.
├── client/                  # React Application (frontend)
│   ├── README.md
│   ├── package.json         # Node/npm app configuration
│   ├── public/              # Basic webapp configuration files, for local runs
│   ├── build/               # Production bundle home; built using public/ and src/
│   └── src/
│        ├── assets/         # Project images, videos, etc.
│        ├── containers/     # Top level "smart" components for app's pages
│        ├── lib/            # Shared data, configuration, and utilities
│        ├── styles          # High-level css styles for normalization
│        ├── App.js          # Main app component/container
│        └── index.js        # Top-level entrypoint for React
│
├── server/                  # Flask Application (backend)
│   ├── main.py              # Entrypoint for server
│   ├── env.py               # Environment setup
│   ├── configs.py           # Environment dependent configuration setup
│   ├── firebase.py          # Firebase setup for Firestore DB
│   ├── match.py             # Utilities for calculating user matching
│   └── tests.py             # All of the necessary backend testing code
│
├── dev.sh                   # Local server startup code
├── prod.sh                  # Production server startup code
├── test.sh                  # Runs all application tests
├── runtime.txt              # Python configuration
├── Pipfile                  # Pip dependencies for server
├── Procfile                 # Heroku startup configuration file
└── README.md

Future Improvements

Open Issues

  • Potential race condition when multiple users update their question rankings at the same time. Could lead to state where ultimate matches list does not show all the users in the room.

    Quick fix: Polling mechanism that "updates" the user's question rankings every minute or so (even if no change occurred). Not ideal because it leads to too many extra calls, and still leaves a period of time with inaccurate information.

    Better solution: Create mutex locks around code that changes the Firestore DB (and potentially use an event queue), specifically where key-update collisions might occur or the most up-to-date information is required. Unfortunately, this could lead to extra latency, but ensures real-time accuracy.

Features (Short-Term)

  • More intuitive home page interface for re-joining past event rooms
  • Flexible event "types" that have their own unique question packs
  • User profile picture upload for easier recognition in real life
  • Event time ranges, along with intelligent garbage collection of rooms on backend

Features (Long-Term)

  • Curated faciliation of 1:1 introductions, rather than simple rank-ordered list of matches
  • Option for more flexible question selection flow for event hosts
  • Chat functionality between event participants

Credits

Early version of the React front-end code was sourced from a Facebook Chicago Hackathon project I built with my team, of the same name.

About

A real-time webapp that combats loneliness and anxiety in social scenarios through digitally facilitated introductions, based around preferred topics of conversation.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published