Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Interested in contributing to the other.js library itself? Read on.
Or see how to embed other.js or create a feature.
These instructions assume you're running macOS and using the Homebrew package manager. They should be trivially adaptable to Linux or other package managers.
- Install the Node Package Manager via
brew install node. - Clone this repo and install its dependencies by running
npm installin its root directory. - Install the EditorConfig plugin for your editor of choice.
- RECOMMENDED: Install Atom or Sublime Text for the most seamless editor integration with our stack.
- Atom users will probably also want to install the linter, linter-eslint and linter-stylelint packages.
- Sublime Text users will probably also want to install the SublimeLinter, SublimeLinter-eslint, SublimeLinter-contrib-stylelint and babel-sublime plugins.
-
Start the development server.
npm start
-
Start an Other Chat client using
https://localhost:8888as its otherjs host. Web client instructions
Run all tests once via:
npm testAutomatically re-run tests upon each save via:
npm run test:watchUpon each commit, assuming the tests pass, Jenkins automatically deploys to https://apps.other.chat via:
npm run dist
npm run deploy