Git Product home page Git Product logo

buzzwordbingo's Introduction

Buzzword Bingo

This project is an open source version of a Buzzword Bingo game for meetings. The idea is to make the litany of meetings that we do more engaging. Diagram of the sustem architecture

The Setup

This app takes advantage of several connected Google Cloud and Google Open Source technologies.

Database Firestore
Backend Server Go running on App Engine with Memorystore (redis) as a cache.
Frontend App Angular
Security Identity Aware Proxy
Build Chain Github to Cloud Build

Getting started

Dependencies

Setup script

Diagram of the system architecture

  • Create a Google Cloud Project
  • Set environmental variable BINGO_PROJECT_ID with project id of your project.
  • Perform multiple tasks by running make project init
  • Upgrade Firestore to Native Mode
  • Setup Oauth on Project
  • Set environmental variable BINGO_OAUTH_ID value given in IAP console.
  • Set environmental variable BINGO_OAUTH_SECRET value given in IAP console.
  • Eanble IAP by runninbg make secure
  • Initilize project using Firestore CLI
  • Make copies of frontend/src/environments/sample.environment.ts and frontend/src/environments/sample.environment.prod.ts named frontend/src/environments/environment.ts and frontend/src/environments/environment.prod.ts
  • Download Firebase config and copy into frontend/src/environments/environment.ts
  • Repeat for frontend/src/environments/environment.prod.ts

Development server

Run make dev for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the js source files. If you update the Golang code, you will have to break out and rerun make dev

Deploy to production

make deploy

Optional Components

Firestore emulator for testing

In order to test you need to setup and install the Firestore emulator, which requires the JDK to be installed.

Firestore Emulator

Cloud Build

Setup a CLI pipeline on a git repo that runs a Cloud Build job to deploy to App Engine. There is a cloudbuild.yaml setup and a builder directory available for doing that. To do this, you need to run make builders and make savecreds

Then you can run Cloud Build deploys using make build

Cloud Functions

Readup on sending Cloud Build notifications using Mailgun. Setup /functions/email/config.json based on the sample file there.

Then run make function

Cloud Scheduler

Purge the system of games, boards, and most importantly, emails older than 30 days.

Set this up by running make schedule


This is not an official Google product.

buzzwordbingo's People

Contributors

tpryan avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.