RadicalxChange/hoverboard

Overview

Fork of the GDG/hoverboard repo for use on the RadicalxChange conference. Much credit due to the GDG folks for creating an awesome template to build from!

Features

Feature	Description
Fast and optimized	91/100 PWA on Lighthouse
Works offline	shitty WiFi on the venue is not a problem anymore
Mobile first	layouts optimized for small screens, Hoverboard can be installed as a native app on your phone
Push notifications	remind about sessions in My schedule, session feedback or target users with a custom message
SEO optimized	index all content and get to the top in search results
Speakers and schedule management	keep and update all information in the Firebase
My schedule	let attendees save sessions they want to visit
Customizable theme	change colors to match your style
Blog	post announcements, updates and useful information

Getting Started

Clone repo locally
Setup Environment
- Install Node.js (v8.9.4 or above)
- Install Firebase CLI: npm i -g firebase-tools or yarn global add firebase-tools
Install project dependencies:
1. npm install or yarn from project root
2. From inside the functions folder, run: npm install firebase-functions@latest firebase-admin@latest --save npm install -g firebase-tools
Login into Firebase CLI: firebase login
Run locally
- npm run serve or yarn serve
Build and deploy to our devo site
- npm run build or yarn build
- firebase deploy

NOTE: By default command using configurations from /configs/development.json. To serve locally or deploy the production app use yarn serve:prod and firebase deploy -P <prod project name here> respectively.

📖 Read the Full Setup Guide.

Docker-based development environment

If you don't want to bother with the dependencies, you can use the docker container for development. NOTE: nobody on the RadicalxChange team has tried this yet, but it looks excellent.

📖 Read more in docker docs.

Updating

Here is a git workflow for updating your fork (or downloaded copy) to the latest version:

git remote add upstream https://github.com/gdg-x/hoverboard.git
git fetch upstream
git merge upstream/hoverboard
# resolve the merge conflicts in your editor
git add . -u
git commit -m 'Updated to the latest version'

Documentation

The Getting Started guide is probably a good first point of call!
📖 Full documentation.

Compatibility

✅ Compatible with latest two version of Chrome, Chrome for Android, Firefox, Opera, Safari, Edge.
❌ IE and Opera Mini aren't supported.

Technology Stack

Polymer 2
Redux
Firebase
Service Worker
CSS Grid

Submitting a Pull Request

Squash commits
Lint your code with eslint (config provided)
Include relevant test updates/additions

Code of Conduct

Read the full version Code of Conduct.

Contributors

This project exists thanks to all the people who contribute. [Contribute].

License

Project is published under the MIT license.
Feel free to clone and modify repo as you want, but don't forget to add reference to authors :)

GDG[x] are not endorsed and/or supported by Google, the corporation.

RadicalxChange / hoverboard