🏆 SFU Fall Hack 2020 Winner 🏆
Team: Legacy Edition
Demo (UI Only, No gameplay)
Built using python, fastapi, socketio, and nuxt, Legacy Edition: Acronym Finder is a multiplayer acronym game motivated by a simple problem; acronym recognition. Gameplay involves being the first person amongst an unlimited playerbase to correctly guess what the underlying phrase of an acronym. Points are then awarded and stored on a global leaderboard.
Example: You are given SFU, and options would include Sloths For Us, Simon Fraser University, etc.
Legacy Edition: Acronym Finder, LEAF for short, is:
- Ready for online multiplayer
- Everyone of your friends can play
- All sorts of acronyms!
- Don't ever fail a hackathon again
- Money will be yours!
- Edition is Legacy
Tech Stack and Deployment
LEAF's backend is coded using fastapi and python 3.8. LEAF's frontend is coded using nuxt.js (a vuejs framework) and the vuetify material design framework. LEAF uses a self developed framework to scrape the web for acronyms and then generate different incorrect versions of the same acronym. We implemented an algorithm to generate incorrect acronyms within a certain degree of "closeness" to the real acronym
Running LEAF
To install LEAF, please follow the steps in order below. Note: Docker and docker-compose is required to run this application (Needed for mongodb).
Mongo DB
docker-compose up -d Backend
Installing and running backend. Note: python > 3.5 is required.
cd backend
pip install -r requirements.txt
python asgi.pyThe backend should now be visible in a browser at localhost:5000. It may take minute for the database to initialize.
Frontend Installing and running frontend. Note: nodejs lts is required.
cd frontend
npm install
npm run devThe frontend should now be visible in a browser at localhost:3000. The application should now be fully functional.
Credits
- Word frequency data for acronym generation was found here.
- https://stackoverflow.com/a/7331558/7910261
- https://github.com/ConnorSMaynes/allacronyms