/dyad-finder

Simple web application implementing the stable roommate algorithm

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

Dyad Finder

standard-readme compliant

Match people in pairs

Dyad Finder helps you find matched pairs of people from a larger group, by inviting group members to share their partner preferences and calculating the best possible matches using the Stable roomates algorithm.

Install

The user interface for this project is writen in HTML5, CSS and Javascript (jQuery) - it requires no installation and can be run directly by visiting the index.html file in a web-browser.

It connects to a back-end server, which is an express app deployed to Firebase.

$ npm install firebase-tools
$ npx firebase login
$ npx firebase init

Test

The test scripts can be run by executing

$ npm run test

from the functions folder.

Deploy

With firebsae configured, deploy the application with

$ npx firebase deploy

API

There is an API!

Contributing

Feel free to dive in! Open an issue or submit PRs.

Dyad Finder follows the Contributor Covenant Code of Conduct.

License

AGL-3.0-or-later © Arthur Taylor