chinchang/vuejsfire-hackathon-starter

Hackathon starter kit based on vue.js and Firebase

VuejsFire Hackathon Starter

VuejsvFire is a project starter kit based on Vue.js JavaScript framework and Firebase as backend. This starter kit is actually born out of my side-project Tolks.

---

Demo • Features • Ingredients • Getting Started • Deployment • Detailed Wiki

Features

• Built over Vuejs' webpack-simple template
• ES6 ready
• Single file components
• In-built User Module
• Twitter/Facebook Authentication
• In-built notification system
• Beautiful design and experience
• Responsive UI

Ingredients

• Vue.js webpack-simple template
• Firebase
• Material Design Icons
• Page loader by Tobias Ahlin
• Roboto font from Google fonts

Getting started with development

• Clone this repo.
• Create a project in Firebase. Note, the app would also run with the default Firebase config included in the project. But its advised to replace it with your own Firebase project.
• Turn on Twitter & Facebook in your Firebase project.
• Replace the Firebase credentials in auth.js.
• Run npm install to install all dependencies.
• Run npm run dev to spin the local server and access your cool app on localhost:8080.

Deployment

• Run npm run build to build the project.
• If you are using Github pages for deployment, you can simply run build-gh-pages.sh instead.

Read more about deployment.

License

Open source under The MIT License