首页 发现 帮助
登录
wiki
/
weseek__growi
镜像自地址 https://github.com/weseek/growi
2
0
派生 0
文件 工单管理 0 Wiki

暂无描述

目录树: 42a6f68fe6
分支列表 标签列表
weseek__growi
ZIP TAR.GZ
Yuki Takei 42a6f68fe6 Update CHANGES.md 9 年之前
bin 662bff5043 omit sprintf 9 年之前
config 4c4d7b5f93 improve loading plugins when development 9 年之前
lib 8c86cfe7fb fix typo 9 年之前
local_modules 0bba632df5 Remove bluebird require 9 年之前
locales 2ace8681bc (WIP) add gravater option 9 年之前
public fdf992adde inject js to server's html templates 9 年之前
resource 8c86cfe7fb fix typo 9 年之前
test 21864a5220 update settings when test 9 年之前
tmp b875cefd69 add tmp/plugins dir 9 年之前
.babelrc 706cb9e6ad tmp 10 年之前
.editorconfig 2d42c72e58 add .editorconfig 9 年之前
.gitignore e5a7d305c1 change the location where plugin-definitions.js is generated and ignore 9 年之前
.jshintrc c0f47c5f82 Re:Crowi 11 年之前
.node-dev.json dc3af550d5 use node-dev and easy-livereload 9 年之前
CHANGES.md 42a6f68fe6 Update CHANGES.md 9 年之前
LICENSE 535cd5f951 update LICENSE 9 年之前
Procfile cb47367bbd add settings for heroku 9 年之前
README.md 2bab220b5f Update README.md 9 年之前
app.js 1fc945a4a7 update documents 9 年之前
app.json 17ed7647d5 update app.json 9 年之前
package.json 662bff5043 omit sprintf 9 年之前
webpack.config.js 750ea3d040 WIP: constructing webpack.common.config.js 9 年之前
wercker.yml a851c7a09a fix wercker.yml 9 年之前
yarn.lock 662bff5043 omit sprintf 9 年之前

README.md

Crowi

crowi-plus Chat on Slack

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
  • Docker Compose 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 Heroku

  1. go to https://heroku.com/deploy
  2. input INSTALL_PLUGINS to install plugins

Using docker-compose

git clone https://github.com/weseek/crowi-plus-docker-compose.git crowi-plus
cd crowi-plus
docker-compose up

see also weseek/crowi-plus-docker-compose

On-premise

Dependencies

  • node 6.x (DON'T USE 7.x)
  • npm 4.x
  • yarn

Start

git clone https://github.com/weseek/crowi-plus.git
cd crowi-plus
yarn
MONGO_URI=mongodb://example.com/crowi npm start

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

Other documents

More info are here.

Getting Started to Develop

Dependencies

  • node 6.x (DON'T USE 7.x)
  • npm 4.x

  • yarn

  • 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
npm run build:prod

watch client-side codes and incremental build

npm run build:dev:watch

run unit tests

npm test

Documentation

License

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