https://github.com/yovanoc/mailsac

Mailsac API Library
https://github.com/yovanoc/mailsac

Last synced: 2 months ago
JSON representation

Mailsac API Library

• Host: GitHub
• URL: https://github.com/yovanoc/mailsac
• Owner: yovanoc
• License: mit
• Created: 2017-12-14T17:27:35.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T06:49:54.000Z (about 2 years ago)
• Last Synced: 2024-08-09T04:59:14.515Z (5 months ago)
• Language: TypeScript
• Size: 1.11 MB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Mailsac

Mailsac API Library

## Installation

 * In the browser

   ```html

   

   ```

   and

   ```javascript

   const Client = new mailsac.Client("API_KEY");

   ```

 * In Node.js

   ```

   $ npm install mailsac

   ```

   and

   ```javascript

   const Client = require("mailsac").Client;

   ```

   or in es6 or TypeScript

   ```javascript

   import { Client } from "mailsac";

   ```

## Development

  You have to rename the config/default.example.json to config/default.json and put your mailsac api in order to run tests

 * Prerequisites

   ```

   $ npm install

   ```

* Lint the ts files

    ```

    $ npm run lint

    ```

    or to fix some errors automatically

    ```

    $ npm run lint:fix

    ```  

* Run the tests

    ```

    $ npm run test

    ```  

* Build the js files

    ```

    $ npm run build

    ```  

## Contributing

All contributions are welcome! If you wish to contribute, please create an issue first so that your feature, problem or question can be discussed.