Giter VIP home page Giter VIP logo

emoji-helper's Introduction

Emoji Helper

An Emoji cheat sheet extension for Chrome, Firefox, Safari and Opera. Also a Bookmarklet. Built because I like spamming my coworkers with 🍄 🐷 🚀 🐌 but fortunately have more important things to keep in mind than the name for 🗿

Visit http://johannhof.github.io/emoji-helper for download links from the official stores.

Development

Since nowadays most browsers allow plugins to be written in HTML/CSS/JS, it is very easy to build a cross-browser extension, especially when you're not interested in low-level browser functionality.

Building

The build process is done through Gulp. Each submodule (chrome, safari, firefox, bookmarklet) has its own Gulpfile which takes care of building the corresponding extension build, e.g. copying required shared resources from the shared folder.

The generated files are located in the build folders. To load the build folder into the browser, do the following:

Chrome/Opera

$ cd chrome
$ gulp build

Follow this guide https://developer.chrome.com/extensions/getstarted#unpacked and select the build folder.

Firefox

A good introduction to the Mozilla Add-on SDK is https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_started

$ cd firefox
$ gulp build
$ cd build
$ cfx run

Safari

$ cd safari
$ gulp build

The build folder now contains emoji.safariextension, which can be loaded using the Extension Builder (https://developer.apple.com/library/safari/documentation/Tools/Conceptual/SafariExtensionGuide/UsingExtensionBuilder/UsingExtensionBuilder.html)

Bookmarklet

$ cd bookmarklet
$ gulp dev
$ open test.html

gulp dev will start a server to deliver the bookmarklet. You can test/debug the bookmarklet using test.html.

Testing

Since the extension is mostly about the shared frontend, we're using CasperJS for headless browser testing. CasperJS launches a series of tests on the development page of the bookmarklet.

Check out http://docs.casperjs.org/en/latest/installation.html for instructions on how to install CasperJS.

To run the tests, start up the bookmarklet dev task

$ cd bookmarklet
$ gulp dev

Now run the test task with npm

$ npm test

emoji-helper's People

Contributors

webcaetano avatar

Watchers

James Cloos avatar Halid Duraković 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.