Ei kuvausta

Yuki Takei 6e275512a1 testing release-to-github pipeline 9 vuotta sitten
bin e5a7d305c1 change the location where plugin-definitions.js is generated and ignore 9 vuotta sitten
config 76166de01e load jQuery from CDN 9 vuotta sitten
lib e8450e88ba clean code 9 vuotta sitten
local_modules 0bba632df5 Remove bluebird require 9 vuotta sitten
locales 279987f692 omit symlink 9 vuotta sitten
public fdf992adde inject js to server's html templates 9 vuotta sitten
resource 65ee3fd5b0 BugFix .row style for edit-form 9 vuotta sitten
test 21864a5220 update settings when test 9 vuotta sitten
tmp 98e80676bd Fix for multer 1.2 9 vuotta sitten
.babelrc 706cb9e6ad tmp 10 vuotta sitten
.editorconfig 2d42c72e58 add .editorconfig 9 vuotta sitten
.gitignore e5a7d305c1 change the location where plugin-definitions.js is generated and ignore 9 vuotta sitten
.jshintrc c0f47c5f82 Re:Crowi 11 vuotta sitten
.node-dev.json dc3af550d5 use node-dev and easy-livereload 9 vuotta sitten
CHANGES.md 2b4334c3ea update documents 9 vuotta sitten
LICENSE 8069792e45 Move license terms to LICENSE file 11 vuotta sitten
Procfile c0f47c5f82 Re:Crowi 11 vuotta sitten
README.md 5ae671b116 Update README.md 9 vuotta sitten
app.js 1fc945a4a7 update documents 9 vuotta sitten
app.json 1fc945a4a7 update documents 9 vuotta sitten
package.json f9e67ed5dc add npm script 'version' 9 vuotta sitten
webpack.config.js 750ea3d040 WIP: constructing webpack.common.config.js 9 vuotta sitten
wercker.yml 6e275512a1 testing release-to-github pipeline 9 vuotta sitten
yarn.lock 7fd7bb0073 add yarn.lock 9 vuotta sitten

README.md

Crowi

crowi-plus

Deploy

wercker status dependencies status MIT License

This is crowi-plus that is the fork of Crowi, is perfectly compatible with official, and has been enhanced with the following points:

  • Pluggable
  • 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.

Install plugins

  • Stop server if running
  • npm install --save to install plugin or yarn add
    • Don't forget --save option if you use npm or crowi-plus doesn't detect plugins
  • npm start to build client app and start server

Example

yarn add crowi-plugin-lsx
npm start

Getting Started to Develop

Dependencies

What you need to run this app:

  • node and npm (brew install node)
  • following environment is confirmed to work

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

Build and Running the app

  • clone this repository
  • npm install -g npm@4 to install required global dependencies
  • npm install to install all dependencies or yarn
  • npm run build to build client app
  • npm run server to start the dev server in another tab

After you have installed all dependencies and build client you can now run the app. Run npm run server to start a local server using node-dev which will watch server-side codes and reload for you. The port will be displayed to you as http://0.0.0.0:3000.

build and run server

# development
npm run build
npm run server
# production
npm run build:prod
npm run server:prod

Other commands

build client app

# development
npm run build:dev
# production (jit)
npm run build:prod

watch client-side codes and incremental build

npm run build:dev:watch

run unit tests

npm test

Documents

License

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