Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moose-team/friends
:tv: P2P chat powered by the web.
https://github.com/moose-team/friends
Last synced: 4 months ago
JSON representation
:tv: P2P chat powered by the web.
- Host: GitHub
- URL: https://github.com/moose-team/friends
- Owner: moose-team
- License: mit
- Archived: true
- Created: 2015-04-26T04:02:23.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-08-29T02:36:47.000Z (over 6 years ago)
- Last Synced: 2024-05-21T19:40:54.561Z (8 months ago)
- Language: JavaScript
- Homepage: http://moose-team.github.io/friends/
- Size: 1.44 MB
- Stars: 3,166
- Watchers: 145
- Forks: 342
- Open Issues: 53
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-peer-to-peer - friends
- awesome-repositories - moose-team/friends - :tv: P2P chat powered by the web. (JavaScript)
- awesome-github-star - friends - team | 3168 | (JavaScript)
- awesome-peer-to-peer - friends
- awesome-electron-zh - Friends - P2P chat. (Apps / Open Source)
- awesome-electron - Friends - P2P chat.  (Apps / Messenger)
- awesome-starred - moose-team/friends - :tv: P2P chat powered by the web. (others)
- awesomeelectron - Friends - P2P chat. (Apps / Open Source)
README
# Friends
> P2P chat powered by the Web.
[![travis][travis-image]][travis-url]
[![david][david-image]][david-url]
[![javascript style guide][standard-image]][standard-url]
[travis-image]: https://img.shields.io/travis/moose-team/friends/master.svg
[travis-url]: https://travis-ci.org/moose-team/friends
[david-image]: https://img.shields.io/david/moose-team/friends.svg
[david-url]: https://david-dm.org/moose-team/friends
[standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
[standard-url]: https://standardjs.com
**This project is alpha quality.** You probably only want to use this if you like to send pull requests fixing things :)
## How it works
See [our site](http://moose-team.github.io/friends/) or the `gh-pages` branch.
## Install
### Prerequisites
You'll need [Node.js](https://nodejs.org) (`>= 4`) and [npm](https://www.npmjs.com/package/npm) (`>= 2.8.3`).
### Build
Clone the source locally:
```sh
$ git clone https://github.com/moose-team/friends
$ cd friends
```
Install project dependencies:
```sh
$ npm install
```
Compile leveldown for [electron](http://electron.atom.io/):
```sh
$ npm run rebuild-leveldb
```
If you are not on 64-bit architecture, you will have to modify the command in package.json:
```
"rebuild-leveldb": "cd node_modules/leveldown && set HOME=~/.electron-gyp && node-gyp rebuild --target=$(../../version.js) --arch=x64 --dist-url=https://atom.io/download/atom-shell"
```
to use `--arch=ia32`.
## Usage
### GitHub Login
Friends currently uses your git and github configuration for authentication.
If you don't already have a public key on GitHub and corresponding private key on your machine, you'll need to [set that up first](https://help.github.com/articles/generating-ssh-keys/). Make sure your github username is also set, using `git config --global github.user yourusername`.
If you're having trouble getting this part to work, do this to get debug information:
```
$ npm i github-current-user -g
$ DEBUG=* github-current-user
```
and then report an [issue](https://github.com/moose-team/friends/issues).
**Note**: DSA keys are not supported. You should switch to RSA anyway for security reasons.
If it can't verify you, try doing `ssh-add ~/.ssh/id_rsa`. Your key should show up when you run `ssh-add -l`.
### Run
To run from the command line, execute `npm start`.
To create a distributable app, run `npm run package`.
## Contributing
Contributions welcome! Please read the [contributing guidelines](CONTRIBUTING.md) before getting started.
## License
[MIT](LICENSE.md)