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

@justin0022/emoji-feedback

v1.2.1

Published

A simple tool for eliciting feedback via emojis, featuring a feedback form.

Downloads

12

Readme

JavaScript Style Guide tested with jest gzipped_size javascript

Emoji-Feedback 💀 👻 👽 🤖 💩

Working Prototype | Example of integration into dashboard (click "GIVE FEEDBACK" button) GIF of App

A delightful tool for eliciting feedback via emojis, featuring a feedback form. 0 dependencies, written in pure vanilla JavaScript.

Getting Started

These instructions will get you a copy of the project up and running on your local machine.

Prerequisites

  1. Install Node 8.0.0 or greater.
  2. Install Git.

Installing and Setup

  1. First, clone this repo. git clone https://github.com/ubc/emoji-feedback.git
  2. Then cd into the repo. cd emoji-feedback
  3. Run the installation script. npm install (If you see babel-node: command not found, you've missed this step.)
  4. Run using npm start. Webpack Dev Server will host a hot-loading webpage.
  5. To build for production, npm run build will output the production-ready, minified, tree-shaken bundle in /dist.

Usage

Emoji-Feedback can be installed via npm. Since this app requires the DOM, it will not run via Node. I highly recommend using something like Webpack or Rollup to produce a bundle that will be executed by the browser. npm i @justin0022/emoji-feedback

const emojiFeedback = require('@justin0022/emoji-feedback')
const app = emojiFeedback()

const endpoints = {
  emoji: 'http://127.0.0.1:5000/emoji',
  feedback: 'http://127.0.0.1:5000/feedback',
  votes: 'http://127.0.0.1:5000/votes'
}

app.init('entry', endpoints, {
  introText: 'I can customize this!',
  feedbackTextPrompt: 'Please write down below',
  feedbackThankYou: 'Thanks again!',
  emojis: [
    { emojicon: '💀', emotion: 'skull' },
    { emojicon: '👻', emotion: 'ghost' },
    { emojicon: '👽', emotion: 'alien' },
    { emojicon: '🤖', emotion: 'robot' },
    { emojicon: '💩', emotion: 'pile of poo' }
  ]
})

emojiFeedback has one method, init. Init takes 3 arguments: entry, endpoints, options

  • entry is the HTML id attribute that should be unique to the document. This is the entry point of Emoji Feedback.
  • endpoints is an object that contains 3 endpoints: emoji, feedback and votes. emoji and feedback send POST requests that contain the selected emoji(s) and the written feedback in the body of the request, respectively. votes sends a GET request for retrieving the number of times students have voted.
  • options is an optional object that contains introText, feedbackTextPrompt, feedbackThankYou, which allow for configurations of the text, as well as emojis, which can be used to configure the emojis to your liking. It is highly recommend to set the value of emotion to the CLDR short name of the emoji, which can be found at https://unicode.org/emoji/charts/full-emoji-list.html. For example,
const myConfiguredEmoji = [
  { emojicon: '💀', emotion: 'skull' },
  { emojicon: '👻', emotion: 'ghost' },
  { emojicon: '👽', emotion: 'alien' },
  { emojicon: '🤖', emotion: 'robot' },
  { emojicon: '💩', emotion: 'pile of poo' }
]
app.init('entry', endpoints, {
   emojis: myConfiguredEmoji
})

Custom Emoji

Tests

To run the tests, first ensure that the application is running locally (npm start), then npm test will run the Jest unit and UI tests (in Puppeteer's headless mode). If the app is not running locally, then the UI tests will fail, as they rely on the DOM. Code coverage is >90%, and more tests will be added over time.