https://github.com/convoo/convoo-starter
https://github.com/convoo/convoo-starter
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/convoo/convoo-starter
- Owner: convoo
- Created: 2017-03-04T03:49:16.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-05T08:14:34.000Z (about 8 years ago)
- Last Synced: 2025-02-17T23:45:04.195Z (3 months ago)
- Size: 12.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# convoo-starter
A starter for your Polymer app using Firebase and Redux
---
Convoo's starter is a starting point for Polymer apps built on top of the [Polymer Starter Kit](https://github.com/PolymerElements/polymer-starter-kit). Convoo's starter targets
applications that are built using Firebase and Redux.
It comes with:
* Firebase authentication already set up for email as well as social providers
* Redux with polymer-redux set up with three main objects:
1. firebase - object that persists to firebase and syncs with it
1. local - object that persists to local storage and can be used to sync cookie data
1. temp - object that stores temporary values that can be used in that session only - eg: routes
* Internationalization set up with a locales.json file for you to edit
* Example views:
* iron-list view displaying a stream of information from firebase
* Example form saving to firebase
* Example file upload into Firebase Storage
## Setup
### 1 - Get the starter
Using the Polymer CLI:
```
npm install -g polymer-cli
npm install -g generator-polymer-init-convoo-starter
polymer init convoo-starter
```
[Simple Download](https://github.com/convoo/convoo-starter/releases).
### 2 - Setup firebase
```
npm install -g firebase-tools
firebase init
```
When Firebase asks you for your public directory enter `build/unbundled`. Since [Firebase uses HTTP 2](https://firebase.googleblog.com/2016/09/http2-comes-to-firebase-hosting.html) this should be fine.
You can also use `build/bundled` if you prefer.
### 3 - Serving while developing
While developing, you can quickly view wha tyou're working on using:
```
polymer serve
```
### 4 - Build & Deploy
When you're ready to deploy, first build your work and double check it locally:
```
polymer build
firebase serve
```
If everything works as expected then go ahead and deploy using:
```
firebase deploy
```