https://github.com/mattermost/mattermost-driver-javascript
Javascript library for interacting with the Mattermost API
https://github.com/mattermost/mattermost-driver-javascript
hacktoberfest
Last synced: 5 months ago
JSON representation
Javascript library for interacting with the Mattermost API
- Host: GitHub
- URL: https://github.com/mattermost/mattermost-driver-javascript
- Owner: mattermost
- License: apache-2.0
- Archived: true
- Created: 2016-05-13T13:51:25.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-08-16T12:39:53.000Z (over 8 years ago)
- Last Synced: 2024-11-19T12:37:02.037Z (about 1 year ago)
- Topics: hacktoberfest
- Language: JavaScript
- Size: 128 KB
- Stars: 42
- Watchers: 43
- Forks: 40
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Deprecation
API version 3 is [scheduled for deprecation on January 16th, 2018](https://api.mattermost.com/#tag/APIv3-Deprecation) and as part of the deprecation process this driver is no longer maintained. We recommend using the new API version 4 driver available in our [mattermost-redux](https://github.com/mattermost/mattermost-redux) repository.
# Mattermost JavaScript API Library
[](https://www.npmjs.com/package/mattermost) [](https://github.com/mattermost/mattermost-driver-javascript/blob/master/LICENSE.txt)
A library for interacting with the [Mattermost](https://github.com/mattermost/platform) API.
Available on [NPM](https://www.npmjs.com/package/mattermost)
To contribute, please see [Contribution Guidelines](http://docs.mattermost.com/developer/contribution-guide.html)
## Usage
### Installation
The library can be installed using npm:
```
npm install mattermost --save
```
### Usage
Example import methods:
```javascript
var Mattermost = require('mattermost');
var client = new Mattermost.Client()
```
```javascript
import {Client} from 'mattermost';
const client = new Client();
```
### API
API Documentation is coming soon. For now, take a look at the [client.jsx](https://github.com/mattermost/mattermost-driver-javascript/blob/master/client.jsx) file.
## Development
### Building
`make build` - Compiles client.jsx into a minified lib/client.js
`make publish` - Walks though the steps to publish the package (manually)
`make clean` - Cleans up compiled bits and npm dependencies.
### Tests
The tests are in the [main repository](https://github.com/mattermost/platform/tree/master/webapp/tests). This is because they require the server to run.