Hyperchannel (alpha!)

Hyperchannel is the unhosted client application of the Kosmos Chat project. It is based on Ember.js, connecting to IRC/XMPP/etc. via Sockethub (WebSockets + ActivityStreams), and optionally syncing configuration and user data via remoteStorage (Webfinger + OAuth + CORS + REST).

Hyperchannel is not yet ready for public use, but contributions are very welcome. If you know JavaScript, and ideally even have experience with Ember.js, it is easy to hack on any feature imaginable. Check the GitHub issues to find things you could start implementing right away.

If you have any questions, please feel free to ask in one of our chatrooms.

Prerequisites

You will need the following things properly installed on your computer.

• Git
• Node.js (with npm)
• Ember CLI
• Sockethub
• Google Chrome

Installation

• git clone [email protected]:67P/hyperchannel.git this repository
• change into the new directory
• npm install
• https://github.com/sockethub/sockethub/wiki/Installing-Sockethub

Running / Development

• npm start
• Visit the app at http://localhost:4200.
• Visit your tests at http://localhost:4200/tests.

Code Generators

Make use of the many generators for code, try ember help generate for more details

Caveat: when running the model generator, make sure to adjust the unit test to not use moduleForModel, as we're not using Ember Data. See existing tests.

Running Tests

• npm test
• npm test -- --server (will re-run on saving files)

Linting

• npm run lint:hbs
• npm run lint:js
• npm run lint:js -- --fix

Building

(Not yet used.)

• npm build (development)
• npm build --environment production (production)

Deploying

With push permission for the production Git repo:

• npm run deploy

Further Reading / Useful Links

• ember.js
• ember-cli
• Development Browser Extensions
  • ember inspector for chrome
  • ember inspector for firefox

House Rules

Contributor Code of Conduct (TL;DR: Be excellent to each other.)