https://github.com/bogdanq/tic-tac
real time game
https://github.com/bogdanq/tic-tac
nodejs react typescript websocket
Last synced: 3 months ago
JSON representation
real time game
- Host: GitHub
- URL: https://github.com/bogdanq/tic-tac
- Owner: bogdanq
- Created: 2020-11-07T20:54:28.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-03-01T21:38:46.000Z (over 5 years ago)
- Last Synced: 2025-01-21T09:29:15.372Z (over 1 year ago)
- Topics: nodejs, react, typescript, websocket
- Language: TypeScript
- Homepage:
- Size: 871 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Начало работы
### `yarn tsc:watch`
Запускает компилятор ts в режиме наблюдения за файлами и делает сборку в папку `build`
### `yarn dev`
Запускает сервер по порту `localhost:3000`
# API
## users
### user.create
`payload` представлен json-объектом со следующими полями:
| name | type | required | description |
| -------- | ------ | -------- | ------------------- |
| email | string | y | почта пользователя |
| name | string | y | имя пользователя |
| password | string | y | пароль пользователя |
Пример запроса:
```js
{
"type": "",
"method": "user.create",
"payload": {
"email": "bshelomanov@gmail.com",
"name": "Bogdan",
"password": "1111111",
}
}
```
Пример ответа:
```js
{
"type": "",
"method": "user.create",
"payload": {
"email": "bshelomanov@gmail.com",
"name": "Bogdan",
"token": "some token",
"_id": "UHJKMwqe123",
}
}
```
### user.login
`payload` представлен json-объектом со следующими полями:
| name | type | required | description |
| -------- | ------ | -------- | ------------------- |
| email | string | y | почта пользователя |
| password | string | y | пароль пользователя |
Пример запроса:
```js
{
"type": "",
"method": "user.login",
"payload": {
"email": "bshelomanov@gmail.com",
"password": "1111111",
}
}
```
Пример ответа:
```js
{
"type": "",
"method": "user.login",
"payload": {
"email": "bshelomanov@gmail.com",
"name": "Bogdan",
"token": "some token",
"_id": "UHJKMwqe123",
}
}
```
## Дефолтный ответ с ошибкой
```js
{
"method": "user.login",
"payload": null,
"error": ["some error string"],
"code": 400,
}
```