Bez popisu

Yuki Takei 9a583dbf28 update version před 9 roky
bin e5a7d305c1 change the location where plugin-definitions.js is generated and ignore před 9 roky
config 76166de01e load jQuery from CDN před 9 roky
lib e8450e88ba clean code před 9 roky
local_modules 0bba632df5 Remove bluebird require před 9 roky
locales 279987f692 omit symlink před 9 roky
public fdf992adde inject js to server's html templates před 9 roky
resource 65ee3fd5b0 BugFix .row style for edit-form před 9 roky
test 21864a5220 update settings when test před 9 roky
tmp b875cefd69 add tmp/plugins dir před 9 roky
.babelrc 706cb9e6ad tmp před 10 roky
.editorconfig 2d42c72e58 add .editorconfig před 9 roky
.gitignore e5a7d305c1 change the location where plugin-definitions.js is generated and ignore před 9 roky
.jshintrc c0f47c5f82 Re:Crowi před 11 roky
.node-dev.json dc3af550d5 use node-dev and easy-livereload před 9 roky
CHANGES.md e0ee5e3a8a update docs před 9 roky
Dockerfile dd207db59d add Dockerfile před 9 roky
LICENSE 535cd5f951 update LICENSE před 9 roky
Procfile c0f47c5f82 Re:Crowi před 11 roky
README.md 9bfff1b708 Update README.md před 9 roky
app.js 1fc945a4a7 update documents před 9 roky
app.json 1fc945a4a7 update documents před 9 roky
package.json 9a583dbf28 update version před 9 roky
webpack.config.js 750ea3d040 WIP: constructing webpack.common.config.js před 9 roky
wercker.yml d8ce1087d6 testing `yarn install` from wercker před 9 roky
yarn.lock 7fd7bb0073 add yarn.lock před 9 roky

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
  • Docker Ready
  • 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

Using docker-compose

(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.