@tirrilee/admin-bro-firebase
TypeScript icon, indicating that this package has built-in type declarations

1.0.43 • Public • Published

AdminBro Firebase Adapter

Build status Maintainability

Error fixed from JonaszJestem/admin-bro-firebase
Adapter for AdminBro which allows to add your own Firebase resources

Prerequisites

You will need AdminBro panel configured for your project. See AdminBro Repository for instructions

You have to initialize your Firebase app before connecting resources to AdminBro. That means you have to write something like:

// Your firebase config see https://firebase.google.com/docs/web/setup
export const firebaseConfig = {
  // [...]
};

Firebase.initializeApp(firebaseConfig);

Installing

To connect adapter to your AdminBro instance all you need is to:

  1. Register this adapter into AdminBro instance
  2. Write resource with schema
  3. Pass resource to AdminBro config object

Check example folder for full example application!

import * as firebase from "firebase";
import AdminBroExpress from 'admin-bro-expressjs';
import AdminBroFirebase from '@tirrilee/admin-bro-firebase';
import AdminBro from 'admin-bro'; 

const setupAdmin = async expressApp => {
  AdminBro.registerAdapter(AdminBroFirebase);
  const adminBro = new AdminBro({
    branding: {
      companyName: 'Firebase example',
    },
    resources: [
      {
        collection: firebase.firestore().collection('Users'),
        schema: {
          name: 'string',
          isAdmin: 'boolean',
          location: 'mixed',
          attributes: {
            type: 'mixed',
            schema: {
              birthdate: 'date',
              height: 'number',
              eyeColors: 'mixed',
            },
          },
        },
      },
    ],
  });

  const router = await AdminBroExpress.buildRouter(adminBro);
  app.use(adminBro.options.rootPath, router);
};

Authors

Known Issues

Described in Issues tab.

Feel free to contribute.

License

This project is licensed under the MIT License

/@tirrilee/admin-bro-firebase/

    Package Sidebar

    Install

    npm i @tirrilee/admin-bro-firebase

    Weekly Downloads

    1

    Version

    1.0.43

    License

    MIT

    Unpacked Size

    71.1 kB

    Total Files

    62

    Last publish

    Collaborators

    • nab5m
    • brightbong92