Giter Club home page Giter Club logo

gators's Introduction

gators

Free and easy texting framework for node using SMS gateways.

GitHub stars GitHub forks GitHub issues License

import Gators from 'gators'

const emailAuthentication = {
  account: { /* ... */ },
  smtp: { /* ... */ },
  imap: { /* ... */ }
}
const gators = new Gators(emailAuthentication)

gators.on('connected', () => console.log('connected!'))

gators.on('message', (details, sendReply) => {
  const text = details.text.toLowerCase()
  console.log(`> Received message: ${text}`)

  // send reply
  if (text === 'ping') sendReply('pong')
})

gator.on('error', (err: any) => console.log(err))

gator.connect()

NPM

Getting Started

DISCLAIMER: This package has not been tested with all SMS gateway providers nor phone operating systems.

For a list of supported providers, see SUPPORT.md.

For instructions on how you can contribute, see CONTRIBUTE.md.

This is a module from npm.

Before installing, download and install node.js and npm.

Install gators

$ npm i -s gators
# or yarn add gators

Create auth file from template

$ touch auth.js

auth.js

module.exports = {
  account: {
    user: '****@****.com',
    pass: '$!J$#LK#K'
  },
  smtp: {
    host: 'smtp.*****.com',
    port: 465,
    secure: true
  },
  imap: {
    host: 'imap.*****.com',
    port: 993,
    secure: true
  }
}

Manually test with one of the included examples

$ ts-node ./examples/ping

Built With

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Coding Style

JavaScript Style Guide

Authors

  • jdtzmn - Initial work - jdtzmn

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

gators's People

Contributors

jdtzmn avatar

Watchers

 avatar  avatar

gators's Issues

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.