This is a product being built by the Assembly community. You can help push this idea forward by visiting https://assembly.com/prudio.
Assembly products are like open-source and made with contributions from the community. Assembly handles the boring stuff like hosting, support, financing, legal, etc. Once the product launches we collect the revenue and split the profits amongst the contributors.
Visit https://assembly.com to learn more.
This repository is exclusive for the chat.prud.io
part of the project.
It contains:
- The assets (CSS, fonts, sounds and images) of the client.
- The embeddable client script.
- The build script for client script (minimized and compressed).
- Handles the bridge to Slack Websocket.
- Handles the creation of channels in Slack and the counters.
Does not contain:
- Database migrations: it will not work by itself has it does not contain the database migrations (included in the backoffice repo).
Alternatively you can check the database file. You will have to add only a row to your apps
table.
#Install
$ git clone https://github.com/asm-products/prudio-chat.git
$ npm install
$ grunt build
To start your local server use:
$ foreman start
Open your browser at localhost:5000/client-html.
You can check the shipped example at client-html/index.html.
Or this quick example index.html
:
<html>
<head>
<title>Prudio Test</title>
<!-- your CSS and JS -->
</head>
<body>
<h1>Some content</h1>
</body>
<!-- PRUDIO START HERE -->
<script src="/client.local.js?appid=xxx" async></script>
<script>
// OPTIONAL
window._PrudioSettings = {
title: 'Prudio Support',
/*
name: 'John',
email: '[email protected]',
buttonSelector: '#merda',
buttonColor: 'green',
*/
};
</script>
<!-- PRUDIO /END -->
</html>
You can check all the window._PrudioSettings
settings at docs.prud.io (soon) website.
Note: contributions to this project will only be accepted if they reference a design task in the respective project on Assembly or fix a bug or an issue.
Have a look at existing projects and tasks or start a discussion about what you’d like to be working on - you can do that on the Assembly project page.
- Create a Task that describes what you want to do. This gives others the opportunity to help and provide feedback.
- Fork the repo
- Create your feature branch git checkout -b my-new-feature
- Commit your changes git commit -am 'Add some feature’
- Push to the branch git push origin my-new-feature
- Create new Pull Request which references the Task number.
We will accept patches that:
- Don’t break existing functionality.
- Are well documented and commented.
- Are written in strict Javascript only (no Coffeescript, sorry)
Please use the GitHub issues or chat with us at Assembly
When doing CTRL + C
in Foreman the Node.js process does not exit.
This happens because of Socket.io opens a persistent connection to the server and Foreman cannot exit. Try doing killall node
.