Halaman utama Jelajahi Bantuan
Masuk
wiki
/
weseek__growi
cermin dari https://github.com/weseek/growi
2
0
Fork 0
Berkas Masalah 0 Wiki

Tidak Ada Deskripsi

Pohon: 367e30494a
Ranting Tag
weseek__growi
ZIP TAR.GZ
Yuki Takei 367e30494a update yarn.lock 9 tahun lalu
bin 68c6562e9f fix trigger-crowi-plus-docker.sh 9 tahun lalu
config 2660e4cc17 BugFix: devide legacy-form 9 tahun lalu
lib 2660e4cc17 BugFix: devide legacy-form 9 tahun lalu
local_modules 0bba632df5 Remove bluebird require 9 tahun lalu
locales 279987f692 omit symlink 9 tahun lalu
public fdf992adde inject js to server's html templates 9 tahun lalu
resource f86bc86c4d import styles 9 tahun lalu
test 21864a5220 update settings when test 9 tahun lalu
tmp b875cefd69 add tmp/plugins dir 9 tahun lalu
.babelrc 706cb9e6ad tmp 10 tahun lalu
.editorconfig 2d42c72e58 add .editorconfig 9 tahun lalu
.gitignore e5a7d305c1 change the location where plugin-definitions.js is generated and ignore 9 tahun lalu
.jshintrc c0f47c5f82 Re:Crowi 11 tahun lalu
.node-dev.json dc3af550d5 use node-dev and easy-livereload 9 tahun lalu
CHANGES.md e0ee5e3a8a update docs 9 tahun lalu
LICENSE 535cd5f951 update LICENSE 9 tahun lalu
Procfile c0f47c5f82 Re:Crowi 11 tahun lalu
README.md 2470e21145 Update README.md 9 tahun lalu
app.js 1fc945a4a7 update documents 9 tahun lalu
app.json 1fc945a4a7 update documents 9 tahun lalu
package.json dfd76f205f uglify 9 tahun lalu
webpack.config.js 750ea3d040 WIP: constructing webpack.common.config.js 9 tahun lalu
wercker.yml a851c7a09a fix wercker.yml 9 tahun lalu
yarn.lock 367e30494a update yarn.lock 9 tahun lalu

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.