Overview

This repo contains the code and data for the Beam Summit website and is based on Project Hoverboard created by the GDG Lviv team.

Getting Started

1. Fork repository and clone it locally
2. Setup Environment
   • Install Node.js (v8.9.4 or above)
   • Install Firebase CLI: npm i -g firebase-tools or yarn global add firebase-tools
3. Install project dependencies: npm install or yarn
4. Create Firebase account and login into Firebase CLI: firebase login
5. Connect to the Firebase Database
   • Generate serviceAccount.json file
     • Go to https://console.firebase.google.com/project/%YOUR_PROJECT_ID%/settings/serviceaccounts/adminsdk
     • Ensure that Node.js is selected and press GENERATE NEW PRIVATE KEY
     • Save the file as serviceAccount.json and to the root of your hoverboard directory (❗Do NOT commit this file to the public repository)
6. Run locally
   • npm run serve or yarn serve
7. Build and deploy
   • npm run build or yarn build
   • firebase deploy or yarn deploy

NOTE: By default command using configurations from /configs/development.json. To serve locally or deploy the production app use yarn serve:prod and yarn deploy:prod respectively.

📖 Read the Full Setup Guide.

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.

Contributors

Maintainer: Oleh Zasadnyy and Sophie Huts.

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.