A starting point for using Polymer, Firebase, Geofire, and username/provider logins.
Try it at https://app-starter-8f1a5.firebaseapp.com
- Fully operational user-to-user messaging system that includes cloud messaging.
- Integrated permissions system based on user roles.
- List and Map view of "posts". There are two types of posts in the demo.
- Sort posts by their distance to you or another location you specify.
- Use Firebase with usernames instead of cryptic IDs.
- Site-wide theming
- Lighthouse score: 95/100
The purpose of this repo is to be used as a starting point for a new app. A typical way to accomplish that is
- Clone this repo into your own
my-project
directory.
git clone https://github.com/jifalops/app-starter.git my-project
- Setup the git remotes to be able to pull from this project and pull/push to your project.
cd my-project
git remote rename origin app-starter
git remote set-url --push app-starter no-pushing # Set push url to dead end
git remote add origin [YOUR-REPO-URL]
- Replace some strings.
- Replace the necessary information inside
src/app-firebase.html
to use your own Firebase info and replace the existing messaging sender ID infirebase-messaging-sw.js
. Also set your default deploy location in.firebaserc
. - Search the entire project and change
App Starter
toMy Project
andapp-starter
tomy-project
using your preferred editor or some other method. Also update the description of your project, which occurs inindex.html
,bower.json
,package.json
,manifest.json
, andREADME.md
.
- Commit and push your changes.
git add --all
git commit -m 'Initial changes'
git push -u origin master
-
Install dependencies.
bower install --save npm install polymer-cli@next
-
Test locally, requires deploying rules first.
firebase use dev ./internal/make-rules.sh firebase deploy --only database polymer serve
-
Deploy when ready.
# Optional -- setup cloud functions to handle push notifications. firebase init functions polymer build firebase deploy
To update your existing project to use the newest version of app-starter, merge in new changes or rebase your project on top of app-starter.
# If others are working from origin/master.
git merge app-starter master
git push origin master
# Only do this if nobody else is using origin/master
git pull --rebase app-starter master
git push -f origin master
- Fork it on Github.
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request