Giter VIP home page Giter VIP logo

coalk's Introduction

Coalk

TravisCI npm firebase LICENSE

💬 Coalk is comment component base on firebase realtime database for static pages.

Preview Live

Note: This project is developing.

Features

  • Simple and lightweight.
  • No server-side implementation.
  • Support on authentication with gravatr json API.
  • Serverless, data be stored in firebase realtime database.

Install

  • Via npm :
$ npm i coalk
  • Import CDN :
<!-- Temporary vacancy -->
  • Build files :
$ npm i
$ npm run build

Then generate coalk.min.css and coalk.min.js and their sourcemap files in dist folder.

Usage

Add a container to you page:

<div id="coalk"></div>

Then use the Javascript code below to new a comment instance:

<script>
new Coalk({
    apiKey: 'Firebase apiKey',
    databaseURL: 'Firebase databaseURL',
    authDomain: "Firebase authDomain",
    // And other options setting.
});
</script>

About options parameters

Option Default Description
cdn https://gravatar.loli.net/avatar/ string
The gravatar CDN url.
row 8 number
The comment maximum number loaded initially.
language navigator.browserLanguage.toLowerCase() string
The language setting, values: 'en', 'zh-cn'.
apiKey null string
Your firebase apiKey.
authDomain null string
Your firebase Authentication authDomain.
databaseURL null string
Your firebase realtime database databaseURL.

Development

$ git clone [email protected]:huiyifyj/comment.js.git
$ cd comment.js
$ npm install
$ npm run dev

Then open your browser, visit http://127.0.0.1:3000/ .

License

MIT



© 2019   |   Huiyi.FYJ

coalk's People

Contributors

dependabot-support avatar dependabot[bot] avatar huiyifyj avatar pengxn avatar wufaxiayudeyun avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.