widget-chatbot 1.0.0

package/.prettierrc

@@ -0,0 +1,7 @@
+{
+    "tabWidth": 4,
+    "semi": true,
+    "singleQuote": true,
+    "printWidth": 100,
+    "trailingComma": "es5"
+}

package/CHANGELOG.md

@@ -0,0 +1,614 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### [1.0.2](https://https///compare/v1.0.1...v1.0.2) (2023-03-07)
+
+
+### Bug Fixes
+
+* update node-sass to support node12+ ([#458](https://https//undefined/issues/458)) ([5070d24](https://https///commit/5070d24410786b2ad4acc632fa81ab6b49441bc7))
+
+### [1.0.1](https://https///compare/v1.0.0...v1.0.1) (2021-04-15)
+
+
+### Bug Fixes
+
+* readme typo ([f0fa78c](https://https///commit/f0fa78c048d71e52b8a8d2c863e8e2269f2fb834))
+* socket io ([4c1562d](https://https///commit/4c1562d5d62df7f70e12910edcbe093e4dc48e80))
+
+### [1.0.1](https://https///compare/v1.0.0...v1.0.1) (2021-04-15)
+
+
+### Bug Fixes
+
+* readme typo ([f0fa78c](https://https///commit/f0fa78c048d71e52b8a8d2c863e8e2269f2fb834))
+* socket io ([4c1562d](https://https///commit/4c1562d5d62df7f70e12910edcbe093e4dc48e80))
+
+## [1.0.0](https://https///compare/v0.11.12...v1.0.0) (2021-02-01)
+
+### [0.11.12](https://https///compare/v0.11.11...v0.11.12) (2021-01-19)
+
+
+### Features
+
+* expose getSessionId ([c8cbda7](https://https///commit/c8cbda78ec9b746f2697aa8c279c84f1b260fd1f))
+
+### [0.11.11](https://https///compare/v0.11.10...v0.11.11) (2020-10-21)
+
+### [0.11.10](https://https///compare/v0.11.9...v0.11.10) (2020-10-16)
+
+
+### Features
+
+* image size in markdown ([990f4bb](https://https///commit/990f4bb113da8ae1c29528c9b48a279d5efc8393))
+
+### [0.11.9](https://https///compare/v0.11.8...v0.11.9) (2020-10-14)
+
+
+### Bug Fixes
+
+* custom responses ([ae7072c](https://https///commit/ae7072c0dca010dc719d8ecb067726fe8e0e7f9e))
+* image size in markdown ([cee6286](https://https///commit/cee62866b3e61806d389d1728b32864da8f02554))
+
+### [0.11.8](https://https///compare/v0.11.7...v0.11.8) (2020-09-28)
+
+
+### Features
+
+* possibility to send a payload on tooltip close ([38cf679](https://https///commit/38cf67976ba634ad2a6097c6f684ff105ede04e6))
+
+### [0.11.7](https://https///compare/v0.11.6...v0.11.7) (2020-09-16)
+
+
+### Bug Fixes
+
+* colors on buttons using color props ([dbfebe6](https://https///commit/dbfebe63699f67c9baf5551ca0aa588ca4df76d6))
+
+### [0.11.6](https://https///compare/v0.11.5...v0.11.6) (2020-08-27)
+
+
+### Bug Fixes
+
+* code formatting on readme ([2a4f94c](https://https///commit/2a4f94cde3137aff1f73080ce296eadafed8bc25))
+* reload in edge cases ([db6d3d1](https://https///commit/db6d3d140db90e1e417b52c264b0a524489c4a8d))
+
+### [0.11.5](https://https///compare/v0.11.4...v0.11.5) (2020-06-24)
+
+
+### Features
+
+* choose tooltip placement ([aba68c8](https://https///commit/aba68c8b2ad883b85cdf8931d876d809f2beb79e))
+
+### [0.11.4](https://https///compare/v0.11.3...v0.11.4) (2020-06-24)
+
+### [0.11.3](https://https///compare/v0.11.2...v0.11.3) (2020-06-24)
+
+
+### Bug Fixes
+
+* sequence with highlights ([2c69f08](https://https///commit/2c69f08930ab213c1548ec6b1d7d8fac59bae010))
+
+### [0.11.2](https://https///compare/v0.11.1...v0.11.2) (2020-06-23)
+
+
+### Bug Fixes
+
+* bullet points in tooltips ([2c9e92f](https://https///commit/2c9e92f9d20d672ad7d8c991ec7b3db4358bc3a7))
+
+### [0.11.1](https://https///compare/v0.11.0...v0.11.1) (2020-06-23)
+
+
+### Bug Fixes
+
+* webchat opening ([14f457f](https://https///commit/14f457f6a142a1fbde7db972d2f6de0b2063fa34))
+
+## [0.11.0](https://https///compare/v0.10.4...v0.11.0) (2020-06-23)
+
+
+### Features
+
+* auto clear storage on new version to prevent errors ([db2df1e](https://https///commit/db2df1eec7841e2bbcdc20e228c143361218d4dc))
+* placed tooltips ([6857448](https://https///commit/6857448bee206b53c9a10ed3975f6c7247070253))
+* tooltip sequences ([80f048f](https://https///commit/80f048f516b29f032337f07ff85cb787824f3e70))
+
+### [0.10.4](https://https///compare/v0.10.3...v0.10.4) (2020-06-06)
+
+
+### Features
+
+* customize colors ([b2650b5](https://https///commit/b2650b5e5f3aaaf7b5bae7240ddadf8d7bafa27a))
+
+
+### Bug Fixes
+
+* minor style issue on typing indicator ([0b9eb22](https://https///commit/0b9eb228e0573db38c0b77a84571bd279cbbd6f0))
+
+### [0.10.3](https://https///compare/v0.10.2...v0.10.3) (2020-06-01)
+
+
+### Bug Fixes
+
+* auto scrolling ([9c91876](https://https///commit/9c91876aa15b42ba7dbde32ff071b947473776bf))
+
+### [0.10.2](https://https///compare/v0.10.1...v0.10.2) (2020-05-28)
+
+
+### Bug Fixes
+
+* page refresh when pressing enter on firefox ([174d9b9](https://https///commit/174d9b9b0cbff81f7fe832c5e46e5d0a313a254a))
+
+### [0.10.1](https://https///compare/v0.10.0...v0.10.1) (2020-05-27)
+
+## [0.10.0](https://https///compare/v0.9.1...v0.10.0) (2020-05-27)
+
+
+### Features
+
+* message input multiline ([cef1002](https://https///commit/cef10021aee0e4a32a0fd1061dd8b3a884591623))
+* persistent button ([498f1d4](https://https///commit/498f1d4bb5118cb87c3aebcf6373481a123534d3))
+
+
+### Bug Fixes
+
+* markdown lists when embedded mode is active ([46427d1](https://https///commit/46427d143bcd56d8f53f19e4cb07bcd50e73a53f))
+* styles when widget is in full screen mode ([74a95e9](https://https///commit/74a95e9ede83a94b1c0e985a528cf8bc3b8b4912))
+
+### [0.9.1](https://https///compare/v0.9.0...v0.9.1) (2020-05-21)
+
+
+### Bug Fixes
+
+* allow session re-use by re-reading session_id from local storage ([6ea3ffc](https://https///commit/6ea3ffcceb2abc47f1d6fe1cf5c0821cd69fa216))
+
+## [0.9.0](https://https///compare/v0.8.9...v0.9.0) (2020-05-11)
+
+### [0.8.9](https://https///compare/v0.8.8...v0.8.9) (2020-05-05)
+
+
+### Features
+
+* carousels ([98ee08f](https://https///commit/98ee08f96fe4fec504375931c211a6db8abacdba))
+
+### [0.8.8](https://https///compare/v0.8.7...v0.8.8) (2020-04-24)
+
+
+### Features
+
+* allow disabling/enabling input ([333baea](https://https///commit/333baea0c1b87c6d7a99455a0902a6a0f927b20d))
+* change the color of the send button when input is not empty ([#214](https://https//undefined/issues/214)) ([bd75cc5](https://https///commit/bd75cc50b39aab935e6b54281c7d7caa87a9b4c5))
+
+### [0.8.7](https://https///compare/v0.8.6...v0.8.7) (2020-04-16)
+
+
+### Bug Fixes
+
+* scroll to highlight centered on mobile ([560e44b](https://https///commit/560e44b077b55d8a3038736e62bd88a040dcefe9))
+
+### [0.8.6](https://https///compare/v0.8.5...v0.8.6) (2020-04-16)
+
+
+### Features
+
+* automatically scroll to highlights ([47daa28](https://https///commit/47daa287fdb2d6028f12cf6f3c1cb52847e59815))
+
+
+### Bug Fixes
+
+* markdown was not working any more ([#211](https://https//undefined/issues/211)) ([ba2fe55](https://https///commit/ba2fe5502ce6687068c7538be7ce374a9fea4a86))
+* safari blinking animation ([d121a51](https://https///commit/d121a51544bcd589ac91159a1f30fed17000a1c5))
+* scrolling to highligh with chat open ([a967527](https://https///commit/a967527e26be9505c5d4f82e3c0addc461d45851))
+
+### [0.8.5](https://https///compare/v0.8.4...v0.8.5) (2020-04-10)
+
+### [0.8.4](https://https///compare/v0.8.3...v0.8.4) (2020-04-08)
+
+### [0.8.3](https://https///compare/v0.8.2...v0.8.3) (2020-04-06)
+
+### [0.8.2](https://https///compare/v0.8.1...v0.8.2) (2020-04-01)
+
+
+### Bug Fixes
+
+* subtitles display ([3f330f7](https://https///commit/3f330f7ffac1ada84c51348a43899c2fd993aacc))
+
+### [0.8.1](https://https///compare/v0.8.0...v0.8.1) (2020-03-26)
+
+## [0.8.0](https://https///compare/v0.7.23...v0.8.0) (2020-03-25)
+
+
+### Bug Fixes
+
+* message duplicate appearing as a tooltip when closing the chat ([9586994](https://https///commit/958699441987579e8290687343335e619e7d102a))
+
+### [0.7.23](https://https///compare/v0.7.22...v0.7.23) (2020-03-20)
+
+### [0.7.22](https://https///compare/v0.7.21...v0.7.22) (2020-03-19)
+
+
+### Features
+
+* close button for tooltips ([229d90d](https://https///commit/229d90df95d56de5e717cbb1483235c753e14802))
+* support images in tooltips ([104644d](https://https///commit/104644d4623c82e061f317a8eecbb3de7aee41a6))
+* support quick replies in tooltips ([09e9f97](https://https///commit/09e9f9735a469efa219db3af7b1dea5c943b35e9))
+
+
+### Bug Fixes
+
+* removed session_confirm race condition ([ed16933](https://https///commit/ed1693336a72de15fde7a46295b3386921d7bcf3))
+
+### [0.7.21](https://https///compare/v0.7.20...v0.7.21) (2020-02-20)
+
+
+### Features
+
+* sockjs transport can receive multiple messages at once ([ad108de](https://https///commit/ad108de2db807b564c58a99554d5e565c6426801))
+
+### [0.7.20](https://https///compare/v0.7.19...v0.7.20) (2020-02-18)
+
+### [0.7.19](https://https///compare/v0.7.17...v0.7.19) (2020-02-18)
+
+
+### Features
+
+* **sockjs:** session_confirm can contain props ([5f60300](https://https///commit/5f60300813ce25dd3bc15d6d35de37e640621e6c))
+* **sockjs:** session_confirm can contain props ([0102be5](https://https///commit/0102be559b662a954c85428c5f067848d2ab8c29))
+
+
+### Bug Fixes
+
+* crash when trying to hightlight with bad selector ([289b104](https://https///commit/289b1044e3f766eabd9ce506265c5d17507fc29a))
+* default css animations ([dd365ba](https://https///commit/dd365ba0ef7b31e28fa167e924204c2d420d643e))
+* quick replies after refresh ([2fb4c1d](https://https///commit/2fb4c1ddfd25f1dc8c2a13a72a7f4ce7d41c1716))
+
+### [0.7.17](https://https///compare/v0.7.16...v0.7.17) (2020-02-03)
+
+
+### Bug Fixes
+
+* fixed socket update on props update ([ccfbb40](https://https///commit/ccfbb408e898ca9a940ec234aaa0dcbf643765b0))
+
+### [0.7.16](https://https///compare/v0.7.15...v0.7.16) (2020-01-30)
+
+
+### Features
+
+* initial support for pageEventCallbacks ([caf129b](https://https///commit/caf129b3b1d07c829732dde9c9d29d5d9c8311ce))
+
+
+### Bug Fixes
+
+* webchat stuck on typing after refresh ([6d6d2f2](https://https///commit/6d6d2f2c08b571c028bda225eb8443b5b4aeb3dc))
+
+### [0.7.15](https://https///compare/v0.7.14...v0.7.15) (2020-01-29)
+
+### [0.7.14](https://https///compare/v0.7.13...v0.7.14) (2020-01-29)
+
+### [0.7.13](https://https///compare/v0.7.12...v0.7.13) (2020-01-27)
+
+### [0.7.12](https://https///compare/v0.7.11...v0.7.12) (2020-01-22)
+
+
+### Bug Fixes
+
+* reverted to opening links in new tab ([50b4b63](https://https///commit/50b4b63))
+
+### [0.7.11](https://https///compare/v0.7.10...v0.7.11) (2020-01-22)
+
+
+### Bug Fixes
+
+* wrong parameters in initStore ([75fec82](https://https///commit/75fec82))
+
+### [0.7.10](https://https///compare/v0.7.9...v0.7.10) (2020-01-17)
+
+
+### Bug Fixes
+
+* typo in onWidgetEvent ([c6d8588](https://https///commit/c6d8588))
+
+### [0.7.9](https://https///compare/v0.7.8...v0.7.9) (2020-01-15)
+
+
+### Features
+
+* add widget even callback ([904cdf1](https://https///commit/904cdf1))
+* allows the use of ref ([c8f7688](https://https///commit/c8f7688))
+* domHightlight metadata support ([6a9a8d2](https://https///commit/6a9a8d2))
+* forceOpen metadata support ([9034e62](https://https///commit/9034e62))
+* new launcher icon ([4d3675b](https://https///commit/4d3675b))
+
+### [0.7.8](https://https///compare/v0.7.4...v0.7.8) (2019-12-27)
+
+### [0.7.4](https://https///compare/v0.7.3...v0.7.4) (2019-12-19)
+
+
+### Features
+
+* add a send function ([#150](https://https//undefined/issues/150)) ([4221e84](https://https///commit/4221e84))
+
+### [0.7.3](https://https///compare/v0.7.2...v0.7.3) (2019-12-10)
+
+
+### Bug Fixes
+
+* detect text and qr messages when incoming metadata present ([8dcba98](https://https///commit/8dcba98))
+* use message.content -- limitation from stompjs ([32b1e0b](https://https///commit/32b1e0b))
+
+### [0.7.2](https://https///compare/v0.7.1...v0.7.2) (2019-12-04)
+
+
+### Features
+
+* add disconnect reason in socketjs LEAVE ([290e356](https://https///commit/290e356))
+
+### [0.7.1](https://https///compare/v0.7.0...v0.7.1) (2019-11-27)
+
+## [0.7.0](https://https///compare/v0.6.6...v0.7.0) (2019-11-21)
+
+
+### Bug Fixes
+
+* init payload is now sent only when opened ([efebacb](https://https///commit/efebacb))
+
+
+### Features
+
+* added a prop tooltipDelay ([8c8cd95](https://https///commit/8c8cd95))
+* smart typing delay and typing indication ([8738c63](https://https///commit/8738c63))
+* tooltip popup ([04e1279](https://https///commit/04e1279))
+
+### [0.6.6](https://https///compare/v0.6.5...v0.6.6) (2019-10-30)
+
+
+### Bug Fixes
+
+* margin 0 is prefered to margin 0px ([2c0ca86](https://https///commit/2c0ca86))
+* no margin on last child only applies to <p> ([4fe3e9b](https://https///commit/4fe3e9b))
+
+
+### Features
+
+* add margin to <p> to display newline ([c7df04b](https://https///commit/c7df04b))
+
+### [0.6.5](https://https///compare/v0.6.4...v0.6.5) (2019-10-25)
+
+
+### Bug Fixes
+
+* duplicate registration of connect and disconnect event ([263b847](https://https///commit/263b847))
+* duplicate user connection and small refactoring ([58e8925](https://https///commit/58e8925))
+* function binding ([0a035c0](https://https///commit/0a035c0))
+* invalid date if timestamp not present ([4c7be48](https://https///commit/4c7be48))
+* link and add container-class to quickreplies ([67f7fcf](https://https///commit/67f7fcf))
+* lost of path in sockjs implementation ([46adcab](https://https///commit/46adcab))
+* message's date CSS and removed seconds from date ([e0fe602](https://https///commit/e0fe602))
+* sockjs duplicate connection ([991cc6a](https://https///commit/991cc6a))
+
+
+### Features
+
+* display message's date on chat ([3fef7c8](https://https///commit/3fef7c8))
+
+### [0.6.4](https://https///compare/v0.6.3...v0.6.4) (2019-10-18)
+
+
+### Features
+
+* added props connectOn and onSocketEvent ([667c745](https://https///commit/667c745))
+
+### [0.6.3](https://https///compare/v0.6.2...v0.6.3) (2019-10-11)
+
+
+### Bug Fixes
+
+* displayUnreadCount in index ([9d915ad](https://https///commit/9d915ad))
+* displayUnreadCount props ([21ef8c2](https://https///commit/21ef8c2))
+* revert inputTextFieldHint ([cb94a5e](https://https///commit/cb94a5e))
+
+
+### Features
+
+* add unread count pastille on openLauncherMessage ([ee37f19](https://https///commit/ee37f19)), closes [#73](https://https///issues/73)
+* regroup messages in conversation by "sender" ([e837844](https://https///commit/e837844))
+
+### [0.6.2](https://https///compare/v0.6.1...v0.6.2) (2019-10-11)
+
+### [0.6.1](https://https///compare/v0.6.0...v0.6.1) (2019-10-11)
+
+
+### Bug Fixes
+
+* cast messages text into string to prevent crashes ([4778ad8](https://https///commit/4778ad8))
+
+
+### Features
+
+* experimental sockjs support ([b1f7c9d](https://https///commit/b1f7c9d))
+
+## [0.6.0](https://https///compare/v0.5.9...v0.6.0) (2019-10-03)
+
+### 0.5.10 (2019-10-02)
+
+
+### Bug Fixes
+
+* links should open in a new tab ([e238af3](https://https///commit/e238af3))
+* update node-sass version to support node12 ([dd3eee9](https://https///commit/dd3eee9))
+
+
+### Features
+
+* add commitlint and husky ([a040aeb](https://https///commit/a040aeb))
+* add standard version ([573b856](https://https///commit/573b856))
+* add test for quick replies linking ([f95e8f3](https://https///commit/f95e8f3))
+* support web url in quick replies ([ac4b6f1](https://https///commit/ac4b6f1))
+
+### [0.5.10](https://https///compare/v0.5.9...v0.5.10) (2019-10-02)
+
+
+### Bug Fixes
+
+* links should open in a new tab ([e238af3](https://https///commit/e238af3))
+* update node-sass version to support node12 ([dd3eee9](https://https///commit/dd3eee9))
+
+
+### Features
+
+* add commitlint and husky ([a040aeb](https://https///commit/a040aeb))
+* add standard version ([573b856](https://https///commit/573b856))
+* add test for quick replies linking ([f95e8f3](https://https///commit/f95e8f3))
+* support web url in quick replies ([ac4b6f1](https://https///commit/ac4b6f1))
+
+### [0.5.9](https://https///compare/v2.1.1...v0.5.9) (2019-06-06)
+
+
+
+### 0.5.8 (2019-05-07)
+
+
+### Bug Fixes
+
+* css scope ([6c4f7d3](https://https///commit/6c4f7d3))
+
+
+
+### 0.5.7 (2019-04-29)
+
+
+
+### 0.5.6 (2019-03-06)
+
+
+
+### 0.5.5 (2019-02-27)
+
+
+
+### 0.5.4 (2019-01-16)
+
+
+
+### 0.5.3 (2018-12-21)
+
+
+
+### 0.5.2 (2018-12-17)
+
+
+### Bug Fixes
+
+* it was impossible to click behind the empty space of widget button ([8e63321](https://https///commit/8e63321))
+
+
+
+### 0.5.1 (2018-12-03)
+
+
+
+## 0.5.0 (2018-11-28)
+
+
+
+### 0.4.2 (2018-11-14)
+
+
+### Features
+
+* 🎸 Add max-width to images and expose image params ([2d3482b](https://https///commit/2d3482b))
+
+
+### BREAKING CHANGES
+
+* \
+
+
+
+### 0.4.1 (2018-10-29)
+
+
+
+## 0.4.0 (2018-10-19)
+
+
+
+### 0.3.4 (2018-10-12)
+
+
+
+### 0.3.3 (2018-10-06)
+
+
+
+### 0.3.2 (2018-10-06)
+
+
+### Bug Fixes
+
+* testing suite completing appropriately ([e89087e](https://https///commit/e89087e))
+
+
+
+### 0.3.1 (2018-07-11)
+
+
+
+## 0.3.0 (2018-07-06)
+
+
+
+### 0.1.1 (2018-04-29)
+
+
+
+## 0.1.0 (2018-04-11)
+
+
+
+## 0.5.8
+- Namespaced all css declarations so that they don't affect styles outside of the widget.
+
+## 0.5.7
+- Fixed a bug where the connection would not close down when the component unmounted and continued polling indefinitely in the background.
+
+## 0.5.6
+- Fixed a bug where named links would not render in a received message
+
+## 0.5.5
+- New prop, `docViewer`, if this props is true, this will treat every link in received messages as a document and will open it in a popup using docs.google.com/viewer (note: this is an experimental feature and should be used with caution)
+
+## 0.5.4
+- When reconnecting to an existing chat session, the bot will send a message contained in the localStorage key specified by the `NEXT_MESSAGE` constant. The message should be stringified JSON with a `message` property describing the message and an `expiry` property set to a UNIX timestamp in milliseconds after which this message should not be sent.
+
+## 0.5.3
+- Added the parameter hideWhenNotConnected to not display the widget when the server is not connected (defaults to true)
+- Fixed issue where the 'connected' property was being loaded from previous session instead of being triggered on actual connection
+- Reduced the size of the widget container on mobile and in fullscreen mode (blocking clicks)
+
+## 0.5.2
+- Added support for custom images for open and close buttons of chatWidget interface
+- Fixed size of chatWidget when closed preventing to take more space than the open button so that we can click around the open button with no problem
+
+## 0.5.0
+- Added session persistence with Rasa Core
+
+## 0.4.3
+- Implemented session persistence for chat widget.
+- Chat messages and widget state params are stored in storage of the browser.
+- Sessions are synchronized with server by a session_id.
+- The param `storage` is exposed which allows the user to specify where the session is stored.
+- In the case of `session`, session storage of the browser is used, and the session persists as long as the browser is open, and is erased after it is closed.
+- In the case of `local`, local storage of the browser is used and the session persists even after the browser is closed. The session is erased when the browser's cookies are cleared.
+- Implemented connecting notifier and disabled input field before session_confirm is received from the server and the session is generated and synchronized.
+- Separate connecting to server and sending initPayload. Server is connected when the component mounts, while initPayload is sent when the chat is toggled open and the server is connected.
+
+## 0.4.2
+- Added a image size property to widget initialization, in order to crop-scale images returned by bot.
+- Images are crop-scaled to the defined size by the CSS property {object-fit: cover}. The content is sized to maintain its aspect ratio while filling the element’s entire content box. If the object's aspect ratio does not match the aspect ratio of its box then the object will be clipped to fit. The clipping will be taken from the center.
+- `WebChat.toggle()`, `WebChat.open()`, and `WebChat.close` can be used to change the state of the chat box to open or closed.
+- `WebChat.show()` and `WebChat.hide()` can be used to show or hide the entire chat widget.
+- `WebChat.isOpen()` and `WebChat.isVisible()` can be used to get the open state of the chat box and the visibility state of the entire widget.
+
+## 0.4.1
+- Removed Linkify, added markdown support for response messages (urls still are detected automatically but not emails, to ensure a link appears use markdown syntax)
+- Fixed fullScreenMode prop: now dispatches the initPayload when the component mounts, removed border-radius

package/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing
+
+First off, thank you for considering contributing to this project! Now, to start contributing:
+
+## Issues and suggestions
+
+If you either find a bug or have any suggestion or opinion you want to discuss and share, please open an issue and add the proper label to it so we can get in contact with you.
+There are no wrong opinions! All feedback is welcome to make this the most suitable tool for you to use and for us to grow.
+
+## How to contribute
+
+If you have a new feature you want to add or a bug you think you can fix, follow this steps:
+
+1. Fork the repo
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request with **clear title and description**
+
+## Installation
+
+To get this project up and running, you need to build it with
+
+```bash
+npm run build
+```
+
+and then, add it to a dummy project using the file instead of the package. You can use either yarn or npm:
+
+```bash
+npm i <path-to>/rasa-webchat
+
+yarn add file:<path-to>/rasa-webchat
+```
+
+## Testing
+
+Your new feature **must** be tested with the proper tools. In this project, we use Jest and Enzyme. Once your tests are written, run:
+
+```bash
+npm run test
+```
+
+If there any view changes, you need to add screenshots for what's been changed for us to see any improvement or your new feature.