@osirus/bot v0.3.3

This project is like a handy widget you can plug into other websites. It's built with React and gives users quick access to important project stuff like documentation, APIs, contact info, and more.

Installation

You can install Osirus AI to your website or app via CDN or npm package manager

NPM Installation

To easily install Osirus AI using NPM, follow these steps:

1. Open your terminal.
2. Navigate to your project's root folder.
3. Execute the following command:

npm i @osirus/bot

Once you've successfully installed the package, you can initialize your bot by adding the following code to your JavaScript file:

import OsirusBot from '@osirus/bot';

OsirusBot.init(options)

CDN Installation

You can easily set up the widget by adding the following script just before the closing </body> tag in your HTML:

<script src="https://bot.osirus.ai/lib/umd/osirusai.min.js" type="text/javascript"></script>
<script type="text/javascript">
  OsirusBot.init(options);
</script>

Configure your widget

You have two options for initializing the widget. You can either configure it by providing all the necessary settings as a JavaScript object, or you can simply sign up at https://osirus.ai and create a bot on the platform. Then, specify the botId in your configuration.

The latter method is highly recommended because it allows you to make real-time updates to your widget without requiring any changes to your code.

App set up

If you choose to create your bot on https://osirus.ai, you can initialize the bot using the following method:

OsirusBot.init({
  // ideally, you can store your ID in an environment file for easy access, like: `process.env.OSIRUS_BOT_ID`
  botId: string, 
})

Local Configuration

Below, you will find an example of how to initialize the widget and all the available configuration options:

OsirusBot.init({
  name: string,
  companyName: string,
  companyIconUrl: string,
  customColor: string,
  description: string,
  phoneNumber: string,
  email: string,
  docUrl: string,
  apiDocUrl: string,
  support: {
  	type: 'page' | 'email',
  	value: string,
  },
  schedule: string,
  address: {
  	streetAddress: string,
  	city: string,
  	state: string,
  	postalCode: string,
  	country: string,
  },
  showMap: boolean,
  googleMapApiKey: string,
  popupMessage: string,
  customOptions: [
  	{
  		icon: string,
  		label: string,
  		link: string,
  		openNewTab: boolean,
  	},
  ] 
})

Osirus Options