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

https://github.com/ringcentral/glipped

Invite Users to a Public Glip Group. Express app using Swig to invite users to Glip Group
https://github.com/ringcentral/glipped

glip glip-group invite-users

Last synced: 12 months ago
JSON representation

Invite Users to a Public Glip Group. Express app using Swig to invite users to Glip Group

Awesome Lists containing this project

README

          

[![Build Status](https://travis-ci.org/ringcentral/Glipped.svg?branch=master)](https://travis-ci.org/ringcentral/Glipped)
[![Code Climate](https://img.shields.io/codeclimate/github/anilkumarbp/Glipped.svg)](https://codeclimate.com/github/anilkumarbp/Glipped)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Chat: RingCentral](https://img.shields.io/badge/Chat-RingCentral-orange.svg)](https://glipped.herokuapp.com/)
[![npm (scoped)](https://img.shields.io/npm/v/@cycle/core.svg)]()
[![David](https://img.shields.io/david/expressjs/express.svg)](https://david-dm.org/anilkumarbp/glipped)
[![Coverage Status](https://coveralls.io/repos/github/anilkumarbp/Glipped/badge.svg?branch=master)](https://coveralls.io/github/anilkumarbp/Glipped?branch=master)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/fb9bbae6b5f34945b2af1f283fc8538a)](https://www.codacy.com/app/anilkumarbp/Glipped?utm_source=github.com&utm_medium=referral&utm_content=anilkumarbp/Glipped&utm_campaign=Badge_Grade)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/anilkumarbp/Glipped/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/anilkumarbp/Glipped/?branch=master)

# Glipped

A simple Express Server App to invite users to Glip Groups.

# Features
- A landing page you can point users to fill in their
emails and receive an invite into the `Glip` group.
- A SVG badge that works well from static mediums
(like GitHub README pages)


## Requirement

* Node - 7.4.0
* Express - 4.11.xx

## Installation via NPM

```bash
$ cd glipped
$ npm install
```

## Running `Glipped` locally

```bash
$ cp config-sample.env.txt .env
$ vi .env
```

1. Enter the indicated values:

* **RC_APP_KEY=** Your application's `app_key`
* **RC_APP_SECRET=** Your application's `app_secret`
* **RC_APP_SERVER_URL=** Either `sandbox` -OR- `production`
* **RC_USERNAME=** Glip User's `phone-number`
* **RC_EXTENSION=** Glip User's `extension`
* **RC_PASSWORD=** Glip User's `password`
* **APP_LOGO=** Organizations's `logo` ( a http / https link to the Logo )
* **GLIP_GROUP_NAME=** Organization's `name`
* **GLIP_GROUP_ID=** Group ID of the glip `group`

** To GET the `groupId` of the group please ref to [Get Group List](https://developer.ringcentral.com/api-explorer/latest/index.html#/!/Glip_API/loadGroupList);

```
npm start
```

## Running `Glipped` on Heroku

If you already have your Glip email address and password, you can use [Heroku One-Button Deployment](https://devcenter.heroku.com/articles/heroku-button).

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

To run the unit tests:
```
npm test
```

** Application would be started on port 8080 ( http://localhost:8080 )

### SVG

[![Chat: RingCentral](https://img.shields.io/badge/Chat-RingCentral-orange.svg)](http://localhost:8080/)

```html

```

Done in Markdown this looks like:

[![Chat: RingCentral](https://img.shields.io/badge/Chat-RingCentral-orange.svg)](http://localhost:8080/)

### Landing page

![APP screenshots](assets/demo.png)

Point to `http://localhost:8080/`.

**Note:** the image for the logo of the landing page
is retrieved from the `RC_LOGO` parameter specified in the .ENV file. If you do not provide the `URL` in the `.ENV` file, it won't be shown.

## Dependencies

Current used RCSDK version for this demo is :
[ "ringcentral": "^3.1.1"](https://github.com/ringcentral/ringcentral-js/tree/3.1.1)
* Make sure to change the SDK version in the package.json before you chose to use a different SDK Version.

## Links

Project Repo

* https://github.com/anilkumarbp/Glipped

RingCentral SDK for JavaScript

* https://github.com/ringcentral/ringcentral-js

RingCentral API Docs

* https://developer.ringcentral.com/api-and-docs.html

RingCentral API Explorer

* https://developer.ringcentral.com/api-explorer/latest/index.html

## Contributions

Any reports of problems, comments or suggestions are most welcome.

Please report these on [Glipped's Issue Tracker in Github](https://github.com/anilkumarbp/Glipped/issues).

## License

RingCentral SDK is available under an MIT-style license. See [LICENSE.txt](LICENSE.txt) for details.

RingCentral SDK © 2017 by RingCentral

## FAQ

* What if I do not have a RingCentral account? Don't have an account, no worries: [Become a RingCentral Customer](https://www.ringcentral.com/office/plansandpricing.html)
* I/My company is an Independent Software Vendor (ISV) who would like to integrate with RingCentral, how do I do that? You can apply to [Join the RingCentral Partner Program](http://www.ringcentral.com/partner/isvreseller.html)