@crowdrz/crowdrz-js

Query builder for social APIs.
Explore the docs »

Report Bug · Request Feature

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
• Test
• Roadmap
• Contributing
• License

Getting Started

Prerequisites

This project uses node and npm.

• npm

npm install npm@latest -g

Installation

• Install package with npm or yarn.

# NPM
npm install --save @crowdrz/crowdrz-js

# Yarn
yarn add @crowdrz/crowdrz-js

• include it in your code.

const Crowdrz = require('@crowdrz/crowdrz-js')

Usage

const Crowdrz = require('@crowdrz/crowdrz-js')

const apiToken = '<api key>'

const facebook = new Crowdrz('facebook')
facebook.setToken(apiToken)
const me = await facebook.call('GET', '/me')
const me2 = await facebook
  .setMethod('GET')
  .setEndpoint('/me')
  .call()
const me3 = await facebook.setEndpoint('/me').get()
console.log(me, me2, me3) // Same Output

Test

npm test

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

• Fork the Project
• Create your Feature Branch (git checkout -b feature/AmazingFeature)
• Commit your Changes (git commit -m 'Add some AmazingFeature')
• Push to the Branch (git push origin feature/AmazingFeature)
• Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.