Skip to content
This repository has been archived by the owner on Mar 13, 2018. It is now read-only.

Commit

Permalink
Merge pull request #187 from shri-2015-org/develop
Browse files Browse the repository at this point in the history
Файнал мёрдж
  • Loading branch information
exah committed Oct 14, 2015
2 parents 8822c2b + d672505 commit 0ed05b1
Show file tree
Hide file tree
Showing 78 changed files with 2,050 additions and 956 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,6 @@ tmp/**/*.*
*.swp
.jshintignore
.jshintrc
logs/
build/
docker/dependensy/data/
34 changes: 0 additions & 34 deletions .jscsrc

This file was deleted.

11 changes: 0 additions & 11 deletions Dockerfile

This file was deleted.

96 changes: 59 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,23 @@ npm cache clean
npm install
```

Install MongoDB with [Homebrew](http://brew.sh/) or use this [link](http://docs.mongodb.org/manual/installation/)
```
brew update
brew install mongodb
```

### Dev
Run MongoDB before run server:
```
mongod
```
DropDB:
```
mongo
use anonymClub-dev
db.dropDatabase();
```
Run dev server:
```
npm run dev
Expand All @@ -37,10 +53,15 @@ Run prod server:
npm run prod
```

### Prod in docker
Нужно установить docker, затем в его консоли:
```
npm run dock
```

# API :smirk_cat:
Описание взаимодействия клиентов и сервера.

Обозначения:
* :white_check_mark: -- Поддержка есть
* :no_entry_sign: -- Поддержки нет
Expand All @@ -52,7 +73,7 @@ npm run prod
Пример: `broadcast:topRooms`.

#### `topRooms`
Обновление топа.
Обновление топа.

Данные:
```
Expand All @@ -64,19 +85,19 @@ npm run prod
rating: number,
}],
}
```
```

Поддержка клиентом | Поддержка сервером
--- | ---
:white_check_mark: | :white_check_mark: :exclamation: (mock)
:white_check_mark: | :white_check_mark:

## `roomcast`
Сообщения, приходящие от сервера всем в комнате. Имена socket.io событий нужно начинать с `roomcast:`

Пример: `roomcast:message`.

#### `message`
Пришло новое сообщение.
Пришло новое сообщение.

Данные:
```
Expand All @@ -87,11 +108,11 @@ npm run prod
text: string,
time: number,
}
```
```

Поддержка клиентом | Поддержка сервером
--- | ---
:white_check_mark: | :white_check_mark: :exclamation: (mock)
:white_check_mark: | :white_check_mark:

#### `attachment`
Сервер добавил метаданные к сообщению.
Expand All @@ -101,14 +122,15 @@ npm run prod
{
roomID: string,
messageID: string,
url: string,
url: string,
index: number,
meta: any, // TODO уточнить
}
```

Поддержка клиентом | Поддержка сервером
--- | ---
:white_check_mark: | :white_check_mark: :exclamation: (mock)
:white_check_mark: | :white_check_mark:

#### `joinUser`
Зашел новый пользователь.
Expand All @@ -121,11 +143,11 @@ npm run prod
avatar: string,
nick: string,
}
```
```

Поддержка клиентом | Поддержка сервером
--- | ---
:white_check_mark: | :white_check_mark: :exclamation: (mock)
:white_check_mark: | :white_check_mark:

#### `leaveUser`
Пользователь нас покинул.
Expand All @@ -136,11 +158,11 @@ npm run prod
roomID: string,
userID: string,
}
```
```

Поддержка клиентом | Поддержка сервером
--- | ---
:white_check_mark: | :white_check_mark: :exclamation: (mock)
:white_check_mark: | :white_check_mark:

## `exchange`

Expand All @@ -163,8 +185,8 @@ npm run prod
},
}
```
Данные ответа:

Данные ответа:
```
{
status: 'OK',
Expand All @@ -180,10 +202,10 @@ npm run prod

Поддержка клиентом | Поддержка сервером
--- | ---
:white_check_mark: | :white_check_mark: :exclamation: (mock)
:white_check_mark: | :white_check_mark:

#### `joinRoom`
* Я хотел бы
* Я хотел бы
- присоединиться к комнате roomID (userID, secret - null)
- присоединиться к случайной комнате (roomID - null)
- восстановиться в комнате roomID как userID
Expand All @@ -198,19 +220,19 @@ npm run prod
userID: string || null,
secretID: string || null,
},
}
}
```
Данные ответа:

Данные ответа:
```
{
status: 'OK',
data: {
identity: {
userID: string,
avatar: string,
nick: string,
secret: string,
userID: string,
avatar: string,
nick: string,
secret: string,
},
room: {
roomID: string,
Expand All @@ -235,7 +257,7 @@ npm run prod

Поддержка клиентом | Поддержка сервером
--- | ---
:white_check_mark: | :white_check_mark: :exclamation: (mock)
:white_check_mark: | :white_check_mark:

#### `leaveRoom`
* Я хотел бы отсоединиться от комнаты roomID.
Expand All @@ -250,10 +272,10 @@ npm run prod
userID: string,
secret: string,
},
}
}
```
Данные ответа:

Данные ответа:
```
{
status: 'OK',
Expand All @@ -269,7 +291,7 @@ npm run prod

Поддержка клиентом | Поддержка сервером
--- | ---
:white_check_mark: | :white_check_mark: :exclamation: (mock)
:white_check_mark: | :white_check_mark:


#### `message`
Expand All @@ -287,10 +309,10 @@ npm run prod
text: string,
time: number,
}
}
}
```
Данные ответа:

Данные ответа:
```
{
status: 'OK',
Expand All @@ -313,7 +335,7 @@ npm run prod

Поддержка клиентом | Поддержка сервером
--- | ---
:white_check_mark: | :white_check_mark: :exclamation: (mock)
:white_check_mark: | :white_check_mark:

#### `searchRoomID`
* Какие комнаты начинаются с букв `partialRoomID`?
Expand All @@ -326,10 +348,10 @@ npm run prod
data: {
partialRoomID: string,
}
}
}
```
Данные ответа:

Данные ответа:
```
{
status: 'OK',
Expand All @@ -351,4 +373,4 @@ npm run prod

Поддержка клиентом | Поддержка сервером
--- | ---
:white_check_mark: | :white_check_mark: :exclamation: (mock)
:white_check_mark: | :white_check_mark:
Loading

0 comments on commit 0ed05b1

Please sign in to comment.