Skip to content

Client library for building amazing bot web apps

License

Notifications You must be signed in to change notification settings

steuerbot/browser-sdk

Repository files navigation

Steuerbot Browser SDK

This is the Browser SDK of Steuerbot for building amazing web bots.

Contents

👨‍💻 Installation

npm install client --save

or

yarn add client

🛠 Integration

Add the script at the end of your body tag and provide an data-url attribute like this:

<body>
  ...
  <script src="steuerbot-browser-sdk.min.js" data-url="https://api.steuerbot.com"></script>
</body>

Optional: Use the default style by adding the stylesheet to your website:

<head>
  ...
  <link rel="stylesheet" href="steuerbot-browser-sdk.min.css" />
  ...
</head>

🚀 Usage

Download a declaration pdf

steuerbot.downloadPdf({
  username,
  password,
  submitId,
});

👏 How to Contribute

The main purpose of this repository to provide the necessary tools and features for building great bots. We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving the Browser SDK of Steuerbot.

Structure

Typescript is used for development. All typescript files are in the src folder.
For generating the stylesheet we use stylus. The styling is defined in style/index.styl.

Development

You can install and build the files with the following commands:

yarn install
yarn build

For easier development you can use

yarn watch

This generates the .js and .css files on every change.

📄 License

Steuerbot Browser SDK is MIT licensed, as found in the LICENSE file.