JavaScript HTML CSS
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
.bowerrc
.editorconfig
.firebaserc
.gitattributes
.gitignore
.jscsrc
.jshintrc
.yo-rc.json
Gruntfile.js
README.md
bower.json
database.rules.json
firebase.json
package.json

README.md

Albatross Project

Description

This project is a boilerplate Progressive Web App (PWA) that utilizes the Google+ API & Meetup.com API, built using Yeoman, AngularJS, Angular Material, and running on a Firebase backend.

It is themed for use by GDG Kansas City. Originally designed by Kyle Paul.

Setup

(NOTE: This implies that you've created a Firebase project & enabled Google auth)

  1. Clone this repository.
  2. Run bower install and npm install for loading/updating resources.
    • NOTE: You will have to install connect-modrewrite manually: npm install connect-modrewrite --save
  3. Rename the config.js.template file in your app to config.js, update the keys with those from your Firebase project.
  4. Update the canonical info for your GDG in the index.html file:
  <link rel="canonical" href="<WEBSITE_URL>" />
  <link rel="publisher" href="<YOUR_GOOGLE+_PROFILE" /> // use the ID not handle
  <meta itemprop="name" content="GDG <YOUR_CITY>">
  ...
  <meta itemprop="image" content="<WEBSITE_URL>/images/gdg-logo.png">
  1. Open the app.js file and set the SITE_SETUP variable to true
  2. Open a terminal window and run grunt serve
  3. When the localhost window opens in your browser, navigate to: http://localhost:9000/admin
  4. Fill in the fields on the Config, Social, and Admins tabs     * Make sure to enter your Gmail address when on the Admins tab!
  5. Open the app.js file and set the SITE_SETUP variable back to false
  6. Update the MailChimp module to use the custom URL for your GDG's mailing list:
    • line 170 in the index.html file
  7. Update the Google Analytics ID to your GDG's property ID
    • line 319 in the index.html file
  8. Create an account with Sentry.io and update the config Url
    • line 360 in the index.html file

How to use

Running Locally

Run grunt serve for livereload viewing/editing.

Build

Run grunt build for building.

Deploy

Run firebase deploy for deploying to Firebase Hosting.

TODOs:

  • Make the MailChimp module dynamic
  • Allow events to be saved to client's calendar
  • Create Gallery module/page