GitHub - aloud-comments/aloud-comments: Web Component commenting engine based on Firebase (and shadow DOM) · GitHub
Skip to content

aloud-comments/aloud-comments

Repository files navigation

Built With Stencil

Aloud Commments, powered by Firebase

You can host it on any static website (or ones with server as well). The only real external dependency is Firebase.

I am using Firebase for

  • Auth
  • Database
  • Storage

Using this component

There are three strategies we recommend for using web components built with Stencil.

Script tag

  • Put a script tag similar to below, in the end of body of your index.html.
<script type="module" src="https://unpkg.com/aloud-comments"></script>
<script nomodule src="https://unpkg.com/aloud-comments/loader"></script>
  • Then you can use the element anywhere in your template, JSX, html etc

Node Modules

  • Run npm install aloud-comments --save
  • npm install aloud-comments/aloud-comments --save also works. It will pull from GitHub main branch.
  • Put a script tag similar to this <script src='node_modules/aloud-comments/dist/aloud-comments.js'></script> in the head of your index.html
  • Then you can use the element anywhere in your template, JSX, html etc

In a stencil-starter app

  • Run npm install aloud-comments --save
  • npm install aloud-comments/aloud-comments --save also works. It will pull from GitHub main branch.
  • Add an import to the npm packages import 'aloud-comments';
  • Then you can use the element anywhere in your template, JSX, html etc

Original project

This project was originally https://github.com/patarapolw/aloud.

About

Web Component commenting engine based on Firebase (and shadow DOM)

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

Contributors