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

pilotfish

v0.15.1

Published

Pilotfish, a toolkit for improving user experience

Downloads

11

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

gorillamaniagorillamania

Keywords

Readme

Build Status

Warning

This code is not production ready. Pilotfish developers are practicing README driven development, so this documentation is being written before the code is actually done. :) If the project interests you and you would like to be notified when the first release is ready, let us know. TODO: Link to newsletter signup.

About

Software should be intuitive, easy, and fun to use. Pilotfish is a user experience platform for web and application developers to build better experiences.

Instead re-writing these common user experiences for each platform over and over again, pilotfish unifies this effort as a community driven project that pulls together the latest best practices in User Experience. Your users get a better experience, and you save time. See plugins for a list of the functionality you gain by using a User Experience Platform.

Pilotfish's architecture comes in 3 components:

  • A thin javascript toolkit that provides a plugin driven architecture for widgets that improve user experience.
  • A server side api, for data collection, processing, and access, for the plugins that require server side support. Source on github
  • A web console to provide allow for configuration of the widgets, analytics, and insights into your users. Source on github

More info can be found on the pilotfish.io website. TODO: Link.

FAQ

Can't I just do this on my own?

Sure, most experienced developers have created experiences like the ones you see here, at least once. Do you want to keep doing that over and over again, or use well tested, high quality interactions?

Isn't this what jQueryUI does?

jQuery is client side only. Pilotfish provides a server side component as well for a complete platform that enables services, analytics, and dynamic interactions for your users.

Do I have to use your server for the plugins that require server side support?

No. While there is a highly available, scalable platform-as-a-service at api.pilotfish.io. You can also download/install the api code and host yourself. See alternate hosting options.

Does it work with jQuery, Prototype, Backbone, Underscore, jQuery UI, YUI, mooTools, dojo, etc.?

Pilotfish currently requires jQuery. We plan on supporting other frameworks soon. Let us know if you are interested in other frameworks, that will guide our priorities. The best way to do this is to file an issue.

That looks like a lot of plugins. Isn't the file huge?

Pilotfish uses a plugin driven architecture, so you only get the plugins you need. The base framework file is only XX when minified/gzipped. TODO: How big.

Why the name pilotfish?

A pilot fish is one of those little fish that hover around sharks and eat the parasites, creating a mutually beneficial relationship with the shark. Similarly, Pilotfish aims to work alongside your application to make it better.

Demo

To see a working sample site, head over to our demo site TODO: Link, where we show off what features we can add to your site.

Getting started

To use pilotfish, first include the base framework:

<script src="//cdn.pilotfish.io/client/latest/pilotfish.min.js"></script>

Then you include the javascript for which plugins you may want to use:

<script src="//cdn.pilotfish.io/plugins/new-user-walkthrough/new-user-walkthrough-stable-min.js"></script>

Depending on the plugin, some additional configuration may be required.

For the Asynchronous version, see: http://jsfiddle.net/Y4dbB/

Plugins

Several core plugins are included with the platform, and there is also a community of developers that create plugins as they are needed.

Core

  • User Notifications

Existing plugins

  • TODO

Ideas for plugins

  • New User Tutorial
  • Javascript Error Handling
  • Online Help
  • Auto Detect Stuck Users
  • Anaytlics Abstraction layer
  • Form Helpers
  • Auto Login
  • Mouse Tracking
  • Session management/timeout
  • Auto Focus Call to Action
  • Bounce Interception
  • Content Personalization Engine
  • Breadcrumbs
  • Keyboard Shortcuts
  • Signup Lightbox
  • Ratings
  • Highlight referred keywords
  • Analtyics Abstraction Layer
  • Workflow Engine
  • Client Side Pagination
  • Tabs
  • Low impact surveys
  • Application Error Handling
  • Application Persona
  • Infinite Scroll
  • Captcha Reworked
  • Auto Complete
  • External Link Notification
  • Progress Bar
  • Manage Copy
  • Date Picker
  • Easter Eggs
  • File Upload
  • Auto Translate This Page
  • Lazy Load Images
  • Customer Chat
  • Social Sharing Tools
  • Feedback
  • Funnel Analysis
  • Feature Flipping/Bucket Testing
  • Browser upgrade notice for unsupported browsers

Have an idea for a plugin? We'd love to hear it. Please file an issue describing your idea.

Browser Compatibility

Pilotfish accepts the burden of browser compatiblity testing, and we aim to make reasonable trade offs for compatibility versus complexity/bloat.

We currently to support all browsers that support querySelectorAll, which as of Aug 26, 2012, that's 93% of the browsing population:

  • Chrome >= 4
  • Firefox >= 3.5
  • Internet Explorer >= 8
  • Safari (including iOS) >= 4

For older browsers that don't support required functionality, we aim to gracefully degrade - silently disabled without causing problems for the user.

Developer note: The reason why we don't inclue IE 7 is because it doesn't support querySelectorAll, which means we would have had to include a library like sizzle to implement this functionality. If the community pushes for IE 7 support, we could implement this via a shim, keeping the library lightweight for the other browsers but having IE 7 download an additional js file, but we are hoping no one notices. :)

Alternate Hosting Options

Picking a specific version

While it is recommend you use the latest stable minified release of the javascript, you may also pick a different release state or lock to a specific version number. Examples:

Self hosting

You may host the javascript files yourself if you like. Simply download them from any of these sources and put them on your servers.

Note that the server side api, and web console are open source, you are free to download/install them and run them on your own server instead of using the Pilotfish hosted solution.

Github CDN

http://pilotfish.github.com/client/latest/pilotfish.min.js

Google CDN

TODO

Yahoo CDN

TODO

License

We aim for you to use this inside your application, so we picked the leased restrictive license we could find. MIT License - see LICENSE

Who is using Pilotfish?

See USING.

Contributing

Would you like to help out? We need:

See doc/helping to get started. See doc/development for guidelines on how to write code that gets included in the production release.

Issues/Requests/Support

We want you to have a good experience, too. :)

Please check out the existing issues, and if you don't see that your problem is already being worked on, please file an issue

More information

  • The wiki (TODO)
  • The Pilotfish Discussion Group (TODO)