npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

fiar

v0.0.0-alpha.12

Published

Fiar cms firebase plugin set

Downloads

0

Readme

Fiar

Fiar is a highly customizable and type-safe Content Management System (CMS) and admin panel built on top of Firebase and react. As Fiar is currently in alpha, please be aware that the APIs are subject to significant changes.

Quick Start

It is best to look at the example where you will find the code in implimentation code in /src/admin.

Define Content Schema

Create a content schema by defining a collection or a standalone document. Below is an example schema for a simple blog with a landing page and a collection of articles.

import * as f from 'fiar/schema'

// Define a collection
export const articles = f.col({
  ref: 'articles', // Firebase collection ref where the published articles are stored
  label: 'Articles', // Label shown in the UI
  titleField: 'title', // Field used by the article list preview for the title
  fields: {
    title: s.string({ label: 'Title' }),
    body: s.text({ label: 'Content' }),
  },
})
export type Article = typeof articles.infer

// Define a standalone document
export const landing = s.doc({
  ref: 'pages/landing', // Firebase document reference
  label: 'Landing page',
  fields: {
    highlightArticle: s.ref({ label: 'Main article', to: () => articles }),
  },
})

export type LandingPage = typeof landing.infer

Initialize the Dashboard

Fiar operates as a collection of loosely coupled plugins. You must include fiarWorkbench, which provides the dashboard. Begin by adding the fiarContent CMS plugin.

import { fiarWorkbench, fiarContent } from 'fiar/plugins'
import { createFiar } from 'fiar'
import { articles, landing } from './content'
import { firestore } from './firebase'

const fiar = createFiar({
  plugins: [fiarWorkbench({ routing: 'hash' }), fiarContent({ firestore, content: [landing, articles] })],
  components: {},
})

const root = document.getElementById('root')
fiar.render(root)

Authenticate Users

To enable user authentication, add the Firebase authentication client and authentication provider instances.

import { EmailAuthProvider } from '@firebase/auth'
import { ...fiarAuth } from 'fiar/plugins'
import { auth } from "./firebase"

const fiar = createFiar({
  plugins: [
    ...
    fiarAuth({ auth, providers: [new EmailAuthProvider()] }),
  ],
  components: {},
})

Set Roles and Permissions

To restrict access with user roles, you need to set up Firebase functions. Export the following authentication hooks with your email-to-role mapping configuration. These add the fiar: admin property to the user customClaims. For existing users, you can update the custom claims by setting { fiar: 'admin' } in the Firebase dashboard.

import { createAuthHooks } from 'fiar/functions'

export const { fiarBeforeCreate, fiarBeforeSignIn } = createAuthHooks({
  open: false,
  users: [['[email protected]', 'admin']],
})

Update databse rules

All unpublished documents reside in the _fiar collection in Firestore unless configured otherwise. In our blog example, we want editors and admins to be able to edit and create draft content. Only admins should have the ability to publish content, and our published content should be publicly available.

match /databases/{database}/documents {
  match /_fiar/{document=**} {
    allow read, write: if request.auth.token.fiar in ['editor', 'admin']
  }
   match /landing/{document=**} {
    allow read: if true;
    allow write: if request.auth.token.fiar == 'admin'
  }
  match /articles/{document=**} {
    allow read: if true;
    allow write: if request.auth.token.fiar == 'admin'
  }
}

Add File Storage

Enable the Firebase storage plugin to add images to your blog.

import { ...fiarStorage } from 'fiar/plugins'
import { storage } from "./firebase"

const fiar = createFiar({
  plugins: [
    ...
    fiarStorage({ storage }),
  ],
  components: {},
})

Use the image field in your schema.

import * as f from "fiar/schema"

export const articles = f.col({
  ...
  fields: {
    ...
    banner: s.image({ label: 'Banner image' }),
  }
})

Follow these steps to get started with Fiar quickly. Enjoy the power of a customizable and type-safe CMS built on Firebase.