mirror of https://github.com/Safe-Support-Chat/ocrcc-chatbox synced 2024-11-22 02:34:55 +00:00

Public repo of the original developers internal version

Go to file

Sharon Kennedy 8eee18ab44 Merge branch 'master' of https://github.com/nomadic-labs/ocrcc-chatbox		2020-03-22 11:07:49 -04:00
__mocks__	test main chatbox functionality	2020-03-13 00:05:12 -04:00
.circleci	fix circleci missing job (#111 )	2019-06-14 22:41:30 -04:00
.storybook	Storybook (#122 )	2019-06-20 20:43:09 -04:00
docs	more pics	2020-03-22 01:02:20 -04:00
jest	Optional Mount Parameters (#123 )	2019-06-20 13:26:02 -04:00
public	change bot username to id	2020-03-22 11:07:41 -04:00
src	change bot username to id	2020-03-22 11:07:41 -04:00
stories	Storybook (#122 )	2019-06-20 20:43:09 -04:00
vendor	adding cleanslate support for style scoping	2018-06-09 08:43:18 -04:00
.eslintrc	Optional Mount Parameters (#123 )	2019-06-20 13:26:02 -04:00
.gitignore	Storybook (#122 )	2019-06-20 20:43:09 -04:00
bookmarklet-flow.gif	doc: fix typo (#84 )	2019-04-27 09:01:23 -04:00
package.json	trying ot get the images to load	2020-03-18 20:35:59 -04:00
README.md	Update README.md	2020-03-22 11:06:20 -04:00
renovate.json	enabling auto merge (#163 )	2019-08-24 09:41:01 -04:00
webpack.config.js	restyle chatbox and some refactoring	2020-02-23 23:12:47 -05:00
yarn.lock	trying ot get the images to load	2020-03-18 20:35:59 -04:00

README.md

Embeddable Matrix Chatbox

Built on:

Usage

<script src="./chatbox.js"></script>
<script>
  EmbeddableChatbox.mount({ 
    matrixServerUrl: "https://matrix.rhok.space",
    botUsername: "@help-bot:rhok.space"
  });
</script>

Options:

Name	Description	Default
`matrixServerUrl` (required)	URL for the Matrix homeserver you want to connect to	`https://matrix.rhok.space`
`botId` (required)	User ID for the bot account that handles invites	`@help-bot:rhok.space`
`introMessage` (optional)	First message the user sees before agreeing to the Terms of Use	`This chat application does not collect any of your personal data or any data from your use of this service.`
`termsUrl` (optional)	URL for the Terms of Use for the chat service	`https://tosdr.org/`
`roomName` (optional)	Name of the chatroom generated in Riot	'Support Chat'
`agreementMessage` (optional)	Text to show to request agreement to the Terms of Use	`Do you want to continue?`
`confirmationMessage` (optional)	Text to show to ask for agreement to continue	`Waiting for a facilitator to join the chat...`
`exitMessage` (optional)	Text to show if the user rejects the Terms of Use.	`The chat is closed. You may close this window.`
`anonymousDisplayName` (optional)	The display name for the chat user.	`Anonymous`
`chatUnavailableMessage` (optional)	Text to show if no-one is available to respond	`The chat service is not available right now. Please try again later.`

Local development

Clone the project:

git clone https://github.com/nomadic-labs/ocrcc-chatbox.git

Install the dependencies:

cd ocrcc-chatbox
yarn

Start the development server:

yarn start

Open the demo page at http://localhost:9000/

Production build

yarn build