0.0.3 • Published 8 years ago

fireuser v0.0.3

Weekly downloads
-
License
MIT
Repository
-
Last release
8 years ago

Fireuser

NPM version NPM downloads Build Status Dependency Status Code Climate Code Coverage License Code Style

| 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

  1. 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> -->
  2. Create a new Fireuser Object:

    var fireuser = new Fireuser("https://<your-app>.firebaseio.com");
  3. 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

  1. Fork repository
  2. Run npm install to install dev dependencies.
  3. Run npm run build to build library (NodeJS version in dist, UMD/Browser version in Dist)
  4. Run npm start to Serve a live/hot reloading dev environment