Skip to content

Instantly share code, notes, and snippets.

@ckib16
Last active March 29, 2023 07:20
Show Gist options
  • Save ckib16/8732561535ed766cd6b8 to your computer and use it in GitHub Desktop.
Save ckib16/8732561535ed766cd6b8 to your computer and use it in GitHub Desktop.
Default README template with the MIT license text.

QuickMarks

QuickMarks is an analytics app for web projects. It helps you track events on your websites. It is built using Rails, Devise, and a few charting libraries.

Quickmarks analytics offers a few key features:

  • A client-side JavaScript snippet that allows a user to track events on their website
  • A server-side API that captures and saves those events to a database
  • A Rails application that displays the captured event data for a user

Installation

Here's how you track your website with Quickmarks:

TODO: ADD INFO

Usage

TODO: Write usage instructions

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

History

Version 0.1 (2015-05-23) - adding Devise and core Rails functionality

Credits

Lead Developer - Chris Kibble (@ckib16) Mentor - Chris Beck (@christopherbeck)

License

The MIT License (MIT)

Copyright (c) 2015 Chris Kibble

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment