Skip to content

Latest commit

 

History

History
70 lines (47 loc) · 4.26 KB

README.md

File metadata and controls

70 lines (47 loc) · 4.26 KB

build status npm package npm downloads npm license

What is React-QuietWater?

React-QuietWater is a comment system based on react, react-css-modules and redux-orm.Its UI draw on zhihu and medium, and think about something from twitter,facebook,quora and other design websites.

If you are interested in its origin,you can view this

Installation

npm install react-quietwater --save

React-QuiertWater is based on React 16,though now it's in alpha,but this summer(2017) it will be released.Although now we don't use much features in this repo(e.g. <ErrorBoundary>),but for future,we need to be familiar with next version of React, so that's why I use it now.If you don't want to use React 16 in your project,sorry for that this repo can't work.

Demo

You can view the online example.And please note that although we use mock data(by easy-mock) for the example but maybe the data don't have correct logic like the real world.This demo is just for showing the UI and the basic logic.But if you want to improve this,pr is always welcomed.

NOTE: Some functions like praise/thumbdown a reply,submit reply/comment are allowable only when you have logined. So for testing React-QuietWater expediently.Default our test api interface doesn't return a token of the user.So We provide a token,you can set it to your config.localStorage.info2Storage.userToken (default the value is 'u_tk', i.e set localstorage.u_tk to the token value).And then you can test these functions otherwise it will redirect to the login page which you set.

NOTE: For now we just support browserHistory.If you use hashHistory,some modules maybe can't work.

Documentation

  • NOTE: We would like to see any pr/(UI design)/(feature request)/enhancement based on our Name origin,but if they breaches our Motivation,we won't accpt them,so we recommend you fork or just copy our repo and modify it to whatever you want.

All you need to do is complete the config options according to your use case.

F & Q

You can view this to know some F & Q.

Design thinking

If you are Chinese,please believe that we have looked through

Thanks for everyone who gives good advice in the comments of above question.They inspire me a lot,thanks!

We would like to listen and appreciate all issues/suggestions about whatever aspects.But please don't just complain ,that's very rude and meaningless.Please don't just think about yourself's thoughts or experience and think them are the best design or blue print.

If you have any good thought,feel free to file an issue or a pr!If you are friendly,we would like to join the discussion,if not,we also accept but you have to prove your thoughts are acceptable by most people and provide feasible scheme.So,if you are not friendly and can't prove and provide.We will don't reply the issue and close it.

License

MIT