Skip to content

Commit

Permalink
Refused connection error and some other things.
Browse files Browse the repository at this point in the history
Message (user) time, local commands, new logo.
ESLint
Volatile history (scrollable) 😎 πŸ‘ πŸ‘
Prepare headers with no-values. w.sh to run locally.
Aggregation instead of composition.
Components should not know about whir.
Alpha. πŸ‘  😎
  • Loading branch information
aichholzer authored and Stefan Aichholzer committed May 30, 2017
1 parent 201194b commit a81a8af
Show file tree
Hide file tree
Showing 19 changed files with 2,545 additions and 750 deletions.
4 changes: 2 additions & 2 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ root = true

[*]
indent_style = space
indent_size = 4
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
indent_size = 4
indent_size = 2
14 changes: 14 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"extends": "airbnb-base",
"plugins": [
"import"
],
"rules": {
"comma-dangle": [
"error",
"never"
],
"no-param-reassign": 0,
"no-console": 0
}
}
72 changes: 0 additions & 72 deletions .jscs.json

This file was deleted.

3 changes: 0 additions & 3 deletions .jshintignore

This file was deleted.

28 changes: 0 additions & 28 deletions .jshintrc

This file was deleted.

55 changes: 8 additions & 47 deletions Gruntfile.js
Original file line number Diff line number Diff line change
@@ -1,51 +1,12 @@
'use strict';


require('dotenv').load();
module.exports = grunt => {

grunt.initConfig({
jshint: {
options: {
jshintrc: true
},
whir: [
'.'
]
},
jscs: {
src: '.',
options: {
config: '.jscs',
fix: true
}
},
nodemon: {
dev: {
script: 'app/index.js',
options: {
args: ['--trace', '--trace-sync-io'],
callback: nodemon => {
nodemon.on('log', event => {
console.log(event.colour);
});
},
env: {
NODE_ENV: grunt.option('env') || 'local',
PORT: process.env.PORT
},
cwd: __dirname,
ignore: ['node_modules/**'],
ext: 'js',
delay: 500
}
}
}
});

grunt.loadNpmTasks('grunt-jscs');
grunt.loadNpmTasks('grunt-nodemon');
grunt.loadNpmTasks('grunt-contrib-jshint');
module.exports = (grunt) => {
grunt.initConfig({
eslint: {
target: ['./app/**/*.js']
}
});

grunt.registerTask('hint', 'Hinting...', ['jshint:whir', 'jscs']);
grunt.loadNpmTasks('grunt-eslint');
grunt.registerTask('default', ['eslint']);
};
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2016 Stefan Aichholzer
Copyright (c) 2017 Stefan Aichholzer

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
55 changes: 34 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,63 @@
[![Dependency status](https://gemnasium.com/badges/github.com/WhirIO/Client.svg)](https://gemnasium.com/github.com/WhirIO/Client)
[![Alpha](https://img.shields.io/badge/status-alpha-8456AC.svg)](https://github.com/WhirIO/Client)

<p align="center">
<a href="http://whir.io"><img src="media/whir.png" alt="whir.io" /></a>
<a href="http://whir.io"><img src="media/whir.png" alt="whir.io" width="420" /></a>
</p>

<p>
<a href="https://asciinema.org/a/4ff69bzz484gopw5hno3ietmm" target="_blank"><img src="https://asciinema.org/a/4ff69bzz484gopw5hno3ietmm.png" /></a>
</p>

### Installation
```
This is still under development.
It might be unstable until this notice is removed.
$> npm i -g whir.io
```

### Getting started:
```
$> npm install -g whir.io
```

### Options:
- `--user || -u`: Your username for a particular channel. `Required`
- `--pass || -p`: Password, when connecting to private channels.
- `--channel || -c`: The channel to join. Default: `whir generated name`
- `--host || -h`: The server running Whir. Default: `chat.whir.io`
- `--mute || -m`: Mute the conversation. Does not require a value.
- `--user || -u`: Your username (per channel) `Required`
- `--pass || -p`: Password, for private channels.
- `--channel || -c`: Channel you are joining (or creating) `Default: random name`
- `--host || -h`: Whir's host `Default: chat.whir.io`
- `--mute || -m`: Mute the conversation.


### Example uses:
### Chat:
```
$> whir.io --user=stefan --channel=friends
```

or

```
$> whir.io -u=stefan -c=friends
$> whir.io -u stefan -c friends
```

or

```
$> whir.io -u=stefan -m
// You will be connected to a randomly named channel.
$> whir.io -u stefan -m
// Connected to a random channel.
// The conversation is muted.
```

or

```
$> whir.io -u stefan -c friends -h myawesomedomain.chat
// Running whir on your own server/domain.
```


### Notes
You can also setup and run your own **whir** server.<br />
Here's how to do that: [https://github.com/WhirIO/Server](https://github.com/WhirIO/Server)


### Contribute
```
fork https://github.com/WhirIO/Server
```


### License

[MIT](https://github.com/WhirIO/Client/blob/master/LICENSE)

### Enjoy!
Loading

0 comments on commit a81a8af

Please sign in to comment.