Synergy
Synergy is a Team Building Platform For Hackathons. Built with Vue.js, Firebase and Python.
Project setup
npm install
Compiles and hot-reloads for development
npm run serve
Compiles and minifies for production
npm run build
Lints and fixes files
npm run lint
Customize configuration
Calling Firebase functions
With an authenticated @firebase/app object,
firebase.functions().httpsCallable("name-of-function")(input_data).then(data => {...})
For more info on the types of functions, visit the official Firebase Documentation.
Making a Firestore transaction
With an authenticated @firebase/app object,
import { db } from "../firebase/init";
db.collection("name-of-collection").doc("doc-identifier").action().then(data => {...})
For more info on actions that can be performed, visit the official Firebase Documentation.
Deployment
After running the buildscript, run the following command after installing the Firebase CLI to deploy the website as well as the functions.
firebase deploy
To deploy only functions,
firebase deploy --only functions
Update recommendations
To run the server locally, fill in input database credentials in RecsUpdate/dadtabase.ini and run
cd RecsUpdate
export FLASK_APP=main.py
python -m flask run
To make an update run, send a GET http server to /update.
To deploy,
cd RecsUpdate
gcloud app deploy
Contributing
To contribute to Synergy, view our contribution guide.