Skip to content

DevFestNordeste/hoverboard

 
 

Repository files navigation

preview-web

Project Hoverboard

Join the chat at https://gitter.im/gdg-x/hoverboard

Project Hoverboard is the next generation conference website template after Project Zeppelin and more optimized version - Project Zeppelin-Grunt.

Template is brought by Oleh Zasadnyy from GDG Lviv.

Do you ❤️ it? Show your support - please, ⭐ the project.

Live demo

Features

✅ Polymer
PRPL pattern
✅ Offline access
✅ i18n
✅ Material design
✅ Animations
✅ Integrated speakers and sessions management
✅ SEO friendly
✅ Optimized and fast
✅ Editable theme colors
✅ Quick deploy

Setup

📖 Full documentation.

Docker based development env

If you don't want to bother with the dependencies, you can develop in the docker container.

Build:

docker build -t hoverboard .

and run:

docker run -it -v "$PWD":/app -p 8080:8080 hoverboard

📖 Read more in docker docs.

Prerequisites

Install polymer-cli:

npm i -g polymer-cli

and Bower:

npm i -g bower

👉 Fork this repository and clone it locally.

Install dependencies
bower install
Start the development server

This command serves the app at http://localhost:8080 and provides basic URL routing for the app:

polymer serve

📖 Read more in setup docs.

Build

This command performs HTML, CSS, and JS minification on the application dependencies, and generates a service-worker.js file with code to pre-cache the dependencies based on the entrypoint and fragments specified in polymer.json. The minified files are output to the build/unbundled folder, and are suitable for serving from a HTTP/2+Push compatible server.

In addition the command also creates a fallback build/bundled folder, generated using fragment bundling, suitable for serving from non H2/push-compatible servers or to clients that do not support H2/Push.

polymer build

Or you can build in Docker container:

docker run -v "$PWD":/app hoverboard polymer build

📖 Read more in deploy 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/master # OR git merge upstream/develop
# resolve the merge conflicts in your editor
git add . -u
git commit -m 'Updated to the latest version'

Who uses the template?

Going to use the template? Go on! The only thing we ask - let us know with a pull request, so we can include you in this list.

GDG DevFest Ukraine
GDG DevFest Sao Paulo
GDG DevFest Hamburg 2015
GDG DevFest Mezam 2015
GDG DevFest Silicon Valley 2015
GDG DevFest Belgium 2015
GDG DevFest South East Nigeria 2015
GDG DevFest Istanbul 2015
GDG Cáceres CodeWeek 2015
GDG Bingham University Website
Google I/O Extended 2016 Kuala Lumpur
GDG DevFest Hamburg 2016
GDG DevFest Mezam 2016
GDG DevFest Vietnam 2016
GDG DevFest Seattle 2016
GDG DevFest Belgium 2016
GDG DevFest Lisbon 2016
GDG DevFest Sudbury 2016
GDG DevFest Hong Kong 2016
GDG DevFest London 2016

Roadmap 🚀

❌ Admin panel
❌ Firebase Integration
❌ My schedule
❌ Push notification
❌ ES2015
❌ Accessibility
❌ Unit/Integration Tests
👉 Propose your feature with creating an issue

Contributing

Project Hoverboard is still under development, and it is open for contributions. Feel free to send PR. If you have any questions, feel free to contact Oleh Zasadnyy.

General workflow
  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Make your changes
  4. Run the tests, adding new ones for your code if necessary
  5. Commit your changes (git commit -am 'Added some feature')
  6. Push to the branch (git push origin my-new-feature)
  7. Create new Pull Request

📖 Read complete contributing guide.

Contributors ✨

See list of contributors.

Maintainer: Oleh Zasadnyy and Sophie Huts.

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

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 :)

Packages

No packages published

Languages

  • HTML 84.6%
  • JavaScript 15.4%