김대욱

Last README.md

Showing 1 changed file with 21 additions and 33 deletions
......@@ -3,50 +3,38 @@
채팅 사이트
============
This is a node.js chat application powered by SockJS and Express that provides the main functions you'd expect from a chat, such as emojis, private messages, an admin system, etc.
이 사이트는 채팅 사이트이다. 채팅에서 요구되는 기본적인 함수들을 구현해놨다.
## Features
- Material Design
- Emoji support
- User @mentioning
- Private messaging
- Message deleting (for admins)
- Ability to kick/ban users (for admins)
- See other user's IPs (for admins)
- Other awesome features yet to be implemented
## 특징
- 직관적인 디자인
- 이모티콘 기능(개발 중)
- 사용자 이름 설정으로 채팅가능
- 특정 사용자 귓속말 기능
- 메세지창 지우기 기능 (관리자)
- 특정 사용자 추방 및 밴 기능 (관리자)
- 다른 유저들의 아이피 보기 (관리자)
- bootstrap을 이용한 반응형 디자인
.
![User Features](http://i.imgur.com/WbF1fi2.png)
.
![Admin Features](http://i.imgur.com/xQFaadt.png)
#### There are 3 admin levels:
- **Helper:** Can delete chat messages
- **Moderator:** The above plus the ability to kick and ban users
- **Administrator:** All the above plus send global alerts and promote/demote users
#### 3 단계의 관리권한:
- **Helper:** 메세지 삭제 권한
- **Moderator:** 메세지 삭제 권한 및 사용자 추방, 밴 기능
- **Administrator:** 위의 기능들과 전체 경고 및 사용자 권한 부여, 박탈 기능
---
## Setup
Clone this repo to your desktop and run `npm install` to install all the dependencies.
## 다운로드방법
당신의 컴퓨터에 현재 repo를 clone 하고 `npm install` 명령어를 실행하세요.
You might want to look into `config.json` to make change the port you want to use and set up a SSL certificate.
사용할 포트를 변경하고 SSL 인증서를 설정하려면 config.json을 살펴보세요.
---
## Usage
After you clone this repo to your desktop, go to its root directory and run `npm install` to install its dependencies.
Once the dependencies are installed, you can run `npm start` to start the application. You will then be able to access it at localhost:3000
## 사용법
당신의 컴퓨터에 현재 repo를 clone 하고 `npm install` 명령어를 실행하세요.
To give yourself administrator permissions on the chat, you will have to type `/role [your-name]` in the app console.
---
`npm start` 명령어를 통해 어플리케이션을 실행하세요. 그러면 localhost:3000에서 접속이 가능합니다.
## License
>You can check out the full license [here](https://github.com/IgorAntun/node-chat/blob/master/LICENSE)
스스로에게 채팅 관리자 권한을 주고 싶다면 `/role [your-name]` 명령어를 사용해 권한을 얻을 수 잇습니다. (서버 컴퓨터로 접속시에만 가능)
This project is licensed under the terms of the **MIT** license.
......