weseek__growi/README.md

crowi-plus

crowi-plus is the fork of Crowi, has been enhanced with the following points:

• Pluggable
  • Find plugins from npm or github!
• Faster
  • Optimize client-side code chunks by Webpack
  • Using CDN
• Secure
  • Upgrade jQuery to 3.x
  • Upgrade other insecure libs
• Added miscellaneous features
• Developer-friendly
  • Less compile time
  • LiveReload separately available by server/client code change
  • Exclude Environment-dependency (confirmed to be developable on Win/Mac/Linux)
    

Quick Start for Production

(TBD)

More info are here.

Startup for Developers

Requirements

• node >= 6.x
• npm >= 4.x
• yarn >= 0.21.x

Confirmed to work

$ node -v
v6.10.0
$ npm -v
4.5.0
$ yarn --version
0.21.3

Start development

# Install Dependencies
yarn
# Build client-side codes
npm run build
# Run development server and watch server-side codes
npm run server

Incremental client-side Building

Run following in another process:

$ npm run build:dev:watch

Other Relational Documents

see github wiki pages

License

• The MIT License (MIT)
• See LICENSE file.