JavaScript CSS HTML Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
config
public
scripts
tests
vendor
.bowerrc
.codeclimate.yml
.editorconfig
.ember-cli
.eslintrc.js
.gitignore
.jshintrc
.travis.yml
.watchmanconfig
CODE_OF_CONDUCT.md
Dockerfile
LICENSE
README.md
ember-cli-build.js
package-lock.json
package.json
testem.js

README.md

Build Status devDependency Status Code Climate

Hyperchannel (pre-alpha!)

Hyperchannel is the unhosted client application of the Kosmos 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.

Prerequisites

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

Installation

Libsass Bindings

You might need to manually execute:

node node_modules/broccoli-sass/node_modules/node-sass/scripts/install.js

Running / Development

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:js
  • npm run lint:js -- --fix

Building

(Not yet used.)

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

Deploying

[TODO]

Further Reading / Useful Links

House Rules

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