|>| Firework.js v1.1.21 |<|

Firework.js v1.1.21 is a Firebase Library, Helps To Write a Simple and Clean Back-End Firebase Code.

Features

Firework.js Library Supports

• Firebase Realtime Database
• Firebase Authentication
• Firebase Storage
• Firebase Admin SDK
• Firebase Notifications System

Installation

Use the package manager npm to install Firework.js.

npm i -g firework.js

You also can import firework library by including the script in your body tag

For production , you can use the latest optimized production version with: :

<!-- production version, optimized for size and speed --> 
<script src="https://cdn.jsdelivr.net/npm/[email protected]/js/firework.min.js"></script>

OR For Development, you can use the latest development version with:

 <!-- development version, includes helpful console warnings --> 
<script src="https://cdn.jsdelivr.net/npm/[email protected]/js/firework-dev.min.js"></script> 

Install Firebase CLI and Init a Project Using Firework CLI

In order to use Firework Username Authentication System, Firebase Admin SDK features And Firework Notifications System which included with Firework.js library , you need to install Firebase CLI, Init a Project Using Firework CLI and Finally deploy to firebase:

STEP(1) First you need to install firebase tools globally:

npm install -g firebase-tools

STEP(2) Then you need to login to firebase console:

firebase login

STEP(3) After that, Init a Project Using Firework CLI in your main project directory:

firework init <firebase-project-id>

STEP(4) Get Your serviceAccount.json File From Your Firebase Console Project Settings -> Service Accounts Tab -> Generate new private key Then Paste it into ./functions Directory, And Rename it to serviceAccount.json, And Agree To Replace.

STEP(5) Final step, Deploy to your firebase console:

firebase deploy

Make Sure To Secure Database Rules For Firework Admin And Username Auth Features, Go To Firebase Console And Check That Your Realtime Database Rules Be Like This:

{
  "rules": {
    "$root": {
      ".read": true, // Change It As You Want
      ".write": true // Change It As You Want
    },
    // Never Change The Following Rules For Your Users Security
    "FIREWORK": {
       "Users": {
         ".read": false,
         ".write": false
       },
       "MasterDeveloperUID": {
         ".read": false,
         ".write": false
       },
       "NotificationTokens": {
         ".read": "auth !== null",
         ".write": "auth !== null",
         ".indexOn": "token"
       },
       "Notifications": {
         ".read": "auth !== null",
         ".write": "auth !== null"
       }
     }
  }
}

Notice : Notice : Don't edit the firework.js pre-built functions unless you are very familiar with them

Notice : Make Sure That [firebase-messaging-sw.js] and [manifest.json] Files Are Exist In Your Project Public Directory.

Documentation

You Can Find Our Documentation and Useful Articles At Our Website Fireworkjs.tk - Still Not Ready Yet -

Conclusion.

• By Using Firework.js , you can write simple code to manage your firebase project.

• Built Based on ( Firebase 6.3.0 + JS ES6 ).

• Fully Supported In All Browers ( Doesn't Support IE Browser )

• Built By BroCoders Team (Hassan Ali) | All Rights Reserved 2019.

License

MIT