Fiora

Language: 简体中文 | English

Fiora is a web chat application. Made by node.js, koa, react.

Function

0. Register user, create group, join group, private chat, group chat
1. Support text, image, code, url types of message
2. Desktop notification, sound notification, notification switch
3. Customize avatar, collect expression, customize group announcement
4. Limit message length, message frequency
5. A simple plugin system

Installation

The project is powered by node.js(>= 7.0) and mongodb database. To install node.js. To install mongodb.

0. Clone this repository git clone git@github.com:yinxin630/fiora.git
1. Go to repository directory and run yarn or npm install
2. Create config file from example config. The devServer, devPort, database, jwtSecret is necessary.
   cp config/project.example.js config/project.js.
3. Run the project server yarn run server or npm run server
4. Run the project client yarn run dev or npm run dev
5. Open http://localhost:8080 and enjoy it

Script

• server: start server
• dev: start client
• build: build client release version
• redexServer: start redux dev tool server
• rnServer: start react native package server
• android: start android client
• ios: start ios client
• test: run test
• eslint: run eslint check

Run Shot

目录结构

|-- [android]                 // react-native android directory
|-- [build]                   // webpack config
|-- [config]                  // config
|    |-- project.js           // project config (need create yourself)
|    |-- project.example.js   // project example config
|    |-- webpack.js           // webpack config
|-- [ios]                     // react-native ios directory
|-- [public]                  // build output directory
|-- [src]                     // source
|    |-- client               // client source
|    |    |-- [action]        // redux action define
|    |    |-- [assets]        // resource
|    |    |-- [common]        // public component
|    |    |-- [middleware]    // message handle middleware
|    |    |-- [reducer]       // redux reducer define
|    |    |-- [rnMobile]      // react native client
|    |    |-- [util]          // tool function
|    |    |-- [webMobile]     // mobile web client
|    |    |-- [webPc]         // pc web client
|    |    |-- api.js          // web global api
|    |    |-- index.html      // html templete
|    |    |-- socket.js       // socket.io client
|    |    |-- store.js        // redux store define
|    |-- server               // server source
|    |    |-- [model]         // database model define
|    |    |-- [police]        // police
|    |    |-- [route]         // route define
|    |    |-- [util]          // tool function
|    |    |-- app.js          // entry
|-- .babelrc                  // babel config
|-- .buckconfig               // react native need config
|-- .eslintignore             // eslint ignore config
|-- .eslintrc.json            // eslint rule config
|-- .flowconfig               // react native need config
|-- .gitignore                // git ignore config
|-- .watchmanconfig           // react native need config
|-- package.json              // npm
|-- yarn.lock                 // yarn
...

Contribute

If you want to add functionality or fix bug, please observe the following process.

0. Fork this repository and clone the fork
1. Install dependencies npm install
2. Modify the code and check for bug
3. Commit your code. If you get any error or warning from eslint, please fix it
4. Create a pull request