Coder Social home page Coder Social logo

petermanser / prudio-chat Goto Github PK

View Code? Open in Web Editor NEW

This project forked from prudiohq/prudio-chat

0.0 2.0 0.0 4.49 MB

Connect your website to your Slack team

Home Page: https://assembly.com/prudio

License: GNU Affero General Public License v3.0

JavaScript 86.48% CSS 13.52%

prudio-chat's Introduction

Prudio Chat Codacy Badge Open Tasks

Connect your website to your Slack team

This is a product being built by the Assembly community. You can help push this idea forward by visiting https://assembly.com/prudio.

How Assembly Works

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.

Repository

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.

Demo (TL;DR)

Demo

#Install

Dependencies

$ 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.

Widget

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.

Contributing

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.

  1. Create a Task that describes what you want to do. This gives others the opportunity to help and provide feedback.
  2. Fork the repo
  3. Create your feature branch git checkout -b my-new-feature
  4. Commit your changes git commit -am 'Add some feature’
  5. Push to the branch git push origin my-new-feature
  6. 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)

Issues

Please use the GitHub issues or chat with us at Assembly

Know issues

Stoping foreman

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.

License

AGPL v3.

prudio-chat's People

Contributors

cossou avatar satblip avatar

Watchers

Peter Manser avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.