0.0.3 • Published 8 years ago
fireuser v0.0.3
Fireuser
| Fireuser is a user/session/presense wrapper for Firebase
Fireuser is a Javascript Library built to simplify implementing standard app functionality when using Firebase (User/Presence Management, Object CRUD/ Listing/Counting).
Fireuser is especially useful when you are trying to administer a Firebase data set (hence the name). Administration dashboards are a breeze thanks to functions like getOnlineUserCount()
that provide analytics data in simple and easy to understand calls.
Features
- Authentication pared to user management
- User Profile created on signup
- Session management
- Descructured Population based on ID
- Role management
Getting Started
Install through npm:
npm install fireuser --save
or
Include the Fireuser bundle in your
index.html
:<script src="http://cdn.prue.io/fireuser/0.0.3/fireuser.min.js"></script> <!-- Or the following for the latest version --> <!-- <script src="http://cdn.prue.io/fireuser/latest/fireuser.min.js"></script> -->
Create a new Fireuser Object:
var fireuser = new Fireuser("https://<your-app>.firebaseio.com");
Start using Fireuser!
//Get count of users fireuser.signup({ username: 'testuser', email: 'some@email.com', password: 'asdfasdf' }).then(function(count){ console.log('Login was successful'); });
Documentation
Contributing
- Fork repository
- Run
npm install
to install dev dependencies. - Run
npm run build
to build library (NodeJS version indist
, UMD/Browser version in Dist) - Run
npm start
to Serve a live/hot reloading dev environment