https://github.com/salimkayabasi/chat-mate
yet another chat server
https://github.com/salimkayabasi/chat-mate
babel docker express jest passportjs react redis server-side-rendering socket-io
Last synced: 4 months ago
JSON representation
yet another chat server
- Host: GitHub
- URL: https://github.com/salimkayabasi/chat-mate
- Owner: salimkayabasi
- Created: 2017-08-08T16:12:28.000Z (almost 8 years ago)
- Default Branch: develop
- Last Pushed: 2022-06-26T09:16:23.000Z (almost 3 years ago)
- Last Synced: 2025-01-06T06:21:40.794Z (6 months ago)
- Topics: babel, docker, express, jest, passportjs, react, redis, server-side-rendering, socket-io
- Language: JavaScript
- Homepage: https://chat-mate.herokuapp.com
- Size: 468 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Chatmate
### Live Demo
Please check it out on [heroku](https://chat-mate.herokuapp.com/)
### Requirements
You should have installed:
- [Node.js][1] (tested on v6.11.0) //LTS version is recommended
- npm (tested on v3.10.10)
- [yarn][2] (tested on v0.27.5)
### Development
1. Clone the repository `$ git clone ...`
2. Install dependencies with `yarn`
Start server:
```bash
yarn watch # with live reload server
```
Client side:
```bash
yarn webpack # build client-side files
```
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
Please check the `Configuration` section
### Linting with ESLint
[ESLint][3] is an open source JavaScript linting utility.
```bash
yarn lint # checking lint errors
yarn lint-fix # fixing minor lint errors
```
### Run tests
For tests we use [Jest][4]
To run test
```bash
yarn test
```
Before running test suites, it will check for lint errors.
And it also print out coverage report after the test
### Docker Image
You can create a docker image with using built-in configuration
```bash
yarn docker
```
this command will create a new image with using `GIT_HASH` of current branch
* Docker must be installed if you want to use this feature
### Configuration
###### *(ENV variables)*
| name | type | required | default |variants |
| ---------------|:--------|:-----------|:------------------|:------------------|
| NODE_ENV | string | optional | development | prod, qa, test |
| GIT_HASH | string | optional | | |
| PORT | number | optional | 3000 | |
| LOG_LEVEL | string | optional | debug | info, warn... |
| LOG_LAYOUT | string | optional | basic | colored... |
| REDIS_URL | string | required | redis://localhost | |
| COOKIE_SECRET | string | required | keyboard cat | |
[1]: https://nodejs.org/
[2]: https://yarnpkg.com/lang/en/
[3]: http://eslint.org/
[4]: https://facebook.github.io/jest/