An open API service indexing awesome lists of open source software.

https://github.com/migme/surfboard

:surfer: Widget to embed Migme in web apps
https://github.com/migme/surfboard

beach frontend sdk web

Last synced: 5 months ago
JSON representation

:surfer: Widget to embed Migme in web apps

Awesome Lists containing this project

README

          

# Surfboard
Widget to bring the Migme fun to web apps.

[![Gitter](https://img.shields.io/badge/gitter-join%20chat-brightgreen.svg)](https://gitter.im/migme/surfboard)
[![Codeship](https://img.shields.io/codeship/737faef0-c964-0132-6f8a-1e9b8d507ee8.svg)](https://codeship.com/projects/75220)
[![Travis CI](https://img.shields.io/travis/migme/surfboard.svg)](https://travis-ci.org/migme/surfboard)
[![Codecov](https://img.shields.io/codecov/c/github/migme/surfboard.svg)](https://codecov.io/github/migme/surfboard)
[![Dependency Status](https://gemnasium.com/migme/surfboard.svg)](https://gemnasium.com/migme/surfboard)
[![JavaScript Standard Style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)
[![npm](https://img.shields.io/npm/v/migme-surfboard.svg)](https://www.npmjs.com/package/migme-surfboard)
[![npm](https://img.shields.io/npm/dm/migme-surfboard.svg)](https://www.npmjs.com/package/migme-surfboard)
[![GitHub Releases](https://img.shields.io/github/downloads/migme/surfboard/latest/total.svg)](https://github.com/migme/surfboard/releases/latest)

![Surfboard Migbot](https://cdn.rawgit.com/cbas/a179036f13f3d43ebc72/raw/36439504320b80e0e03ba6d6cfecc4ce6ba5775e/surfboard.svg "Surfboard Migbot")

## Installation
### NPM
```
npm install migme-surfboard
```
### CDN
Replace `${VERSION}` with a released version number.
```html

```

## Usage

### Loading
```js
// ES6
import Surfboard from 'migme-surfboard'

// CommonJS
var Surfboard = require('migme-surfboard')

// AMD
define(['migme-surfboard'], function (Surfboard) {
// ...
})
```

### Initialization
```
const widget = new Surfboard()
```

### Development
```bash
# Install dependencies
npm install

# Run tests (continuous integration)
npm test

# Run tests (development)
karma start
# ... sans code coverage for clean source maps
# See: douglasduteil/isparta#31
karma start --coverage false

# Build
gulp browserify
# ... forever
gulp watchify
```

### Live Demo
```
npm i -g http-server
http-server
open http://127.0.0.1:8080
```