Skip to content

A beautiful, fast-loading & self-contained feedback box for web apps.

License

Notifications You must be signed in to change notification settings

travis-ci/charmeur

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Charmeur

Charmeur is a Feedback/Contact box for web applications.

It's an extraction from our customer support tool Charm (http://charmhq.com/).

Charmeur is framework-agnostic and doesn't load in any external assets (unless you tell it to).

It's expected to work on any website or web app, regardless of which CSS or JavaScript frameworks you use (or not use), with any browser that supports basic HTML and CSS positioning.

For more modern browsers, it includes a number of progressive enhancements like CSS animations.

You can configure Charmeur depending on what state your app is in (for example, set an email address for your logged in user, so they don't have to enter it again), as well as fully customize all labels and styling.

The project goal is to have the most beautiful, least annoying feedback box for users.

Usage

<script>
__CHARM = { }
</script>
<script src="charmeur.js" defer async></script>

TODO: document manuel invocation TODO: document label customization TODO: document CSS customization

Alpha warning

Right now, Charmeur is an alpha state and lacks documentation, tests and demos, and out of the box only works with Charm itself.

If you use it and improve it and then not send a pull request, a kitten dies! Because of that, please do send pull requests!

Some things to do:

  • More configurable (POST endpoint!)
  • Documentation!
  • Demos
  • Mobile/responsive layout
  • Write tests

Charmeur is licensed under the terms of the MIT License.

About

A beautiful, fast-loading & self-contained feedback box for web apps.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%