Giter Site home page Giter Site logo

goinstant / notifications Goto Github PK

View Code? Open in Web Editor NEW
15.0 36.0 6.0 471 KB

This repo will no longer be updated. GoInstant will be discontinued as of August 31, 2014. Read our blog for more details.

Home Page: http://goinstant.com

License: BSD 3-Clause "New" or "Revised" License

JavaScript 96.79% CSS 3.21%

notifications's Introduction

Build Status

The GoInstant Notifications widget provides real-time growl-like messages inside your application. Easy to extend with custom notification types, namespaces, foundational styles, and sane defaults.

Notifications

Sign up and build a GoInstant application today. You can learn more in our guides, and documentation.

Have questions? Contact us using this form or chat with us on IRC. #goinstant on Freenode.

Packaging

For your convenience, we've packaged the Notifications widget in several ways.

Using our CDN

We host a copy on our CDN. Have a look at the docs to see how to reference those files, as well as how to initialize the component.

How do I build the script myself?

You may have your own build process. We've tried to make it easy to include the Notifications widget in your build process.

Bower

We've packaged the Notifications widget as a bower component.

bower install goinstant-notifications

Component

We've packaged the Notifications widget as a component.

component install goinstant/notifications

Contributing

Development Dependencies

Set-Up

The following assumes that you have already installed the dependencies above.

git clone https://github.com/goinstant/notifications.git
cd notifications
npm install

Building Notifications for Development

The Notifications widget is built as a component. Feel free to manually install dependencies and build using the component command line tool.

For convenience, we've included a simple grunt command for installing component dependencies and building:

grunt build

If this command runs succesfully you'll now have components and build directories in your Git repo root.

Running Tests

Tests are written in mocha. They're run in an HTML file.

Just open the test/index.html file to run the tests.

On Mac OS, you can just run this command to open the HTML Runner in your default browser:

open test/index.html

Running Examples

This will open up an example of Notifications at work, using your local build.

You should have run grunt build already.

1. Copy the example config.

cp config/config.example.js config/config.js

2. Replace the connectUrl with your GoInstant application's connectUrl.

If you haven't signed up for GoInstant yet, you can sign up and create an application here.

After you have an application's connectUrl set inside of config.js:

config.js
window.config = {
  connectUrl: 'https://goinstant.net/YOUR_ACCOUNT/YOUR_APP',
  room: 'goinstant-widget-examples'
};

3. Open the example index and click an example.

open examples/index.html

Widgets are built on top of GoInstant

GoInstant is an API for integrating realtime, multi-user functionality into your app. You can check it out and sign up for free.

License

© 2013 GoInstant Inc., a salesforce.com company

Licensed under the BSD 3-clause license.

notifications's People

Contributors

jeremywright avatar ntassone avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

notifications's Issues

Init template with display none

On widget init, the template's style should be set to display none. Otherwise it is invisible but occupies space at the top of the page and makes it impossible to interact with page elements underneath it. Once an alert gets shown and goes away, the container gets set to display none and the page can be interacted with.

Browserify

It would be nice to make it usable with Browserify.

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.