Начало Каталог Помощ
Вход
wiki
/
weseek__growi
огледало от https://github.com/weseek/growi
2
0
Разклонения 0
Файлове Задачи 0 Уики

Няма описание

ИН на ревизия: cb47367bbd
Клонове Маркери
weseek__growi
ZIP TAR.GZ
Yuki Takei cb47367bbd add settings for heroku преди 9 години
bin cb47367bbd add settings for heroku преди 9 години
config 4c4d7b5f93 improve loading plugins when development преди 9 години
lib ee3a604ff7 clean code преди 9 години
local_modules 0bba632df5 Remove bluebird require преди 9 години
locales 279987f692 omit symlink преди 9 години
public fdf992adde inject js to server's html templates преди 9 години
resource ee3a604ff7 clean code преди 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 e0ee5e3a8a update docs преди 9 години
LICENSE 535cd5f951 update LICENSE преди 9 години
Procfile cb47367bbd add settings for heroku преди 9 години
README.md 91ecde2cd8 update docs преди 9 години
app.js 1fc945a4a7 update documents преди 9 години
app.json cb47367bbd add settings for heroku преди 9 години
package.json cb47367bbd add settings for heroku преди 9 години
webpack.config.js 750ea3d040 WIP: constructing webpack.common.config.js преди 9 години
wercker.yml a851c7a09a fix wercker.yml преди 9 години
yarn.lock 47c84723a0 improve project structure for development plugins преди 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 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

Using Heroku

(TBD)

On-premise

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

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