首頁 探索 說明
登入
wiki
/
weseek__growi
镜像来自 https://github.com/weseek/growi
2
0
複刻 0
檔案 問題管理 0 Wiki

暫無描述

目錄樹: 0075e7f0ce
分支列表 標籤列表
weseek__growi
ZIP TAR.GZ
Yuki Takei 0075e7f0ce Update ISSUE_TEMPLATE.md 8 年之前
.github 0075e7f0ce Update ISSUE_TEMPLATE.md 8 年之前
bin 6ff8f2e663 fix #123: Imprv: Switch paularmstrong/swig to node-swig/swig-templates 8 年之前
config c93196babe tidy libs 8 年之前
lib 3f89f270fe fix typo 8 年之前
local_modules a4ab794cd4 Use POSIX-style paths. 9 年之前
public 9828685ed6 improve affix header 8 年之前
resource ec72408979 imprv: rename, delete, putback modal 8 年之前
test be44b0fbc2 update libs 8 年之前
tmp b875cefd69 add tmp/plugins dir 9 年之前
.babelrc 48dbe895b2 Get rid of babel-preset-es2015 9 年之前
.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 1f8fd6fcbc :+1: version and update docs 8 年之前
LICENSE 535cd5f951 update LICENSE 9 年之前
Procfile dbc71db496 fix Procfile 8 年之前
README.md b6299c1a5c Update README.md 8 年之前
app.js 1fc945a4a7 update documents 9 年之前
app.json 8dc017155e set bonsai version for heroku 9 年之前
package.json 1f8fd6fcbc :+1: version and update docs 8 年之前
webpack.config.js 750ea3d040 WIP: constructing webpack.common.config.js 9 年之前
wercker.yml efd2fc7fa3 update wercker.yml 9 年之前
yarn.lock e174303034 use escape-string-regexp 8 年之前

README.md

Crowi

Demo Site

crowi-plus Chat on Slack

wercker status dependencies status devDependencies Status MIT License

crowi-plus is a fork of Crowi that is perfectly compatible with the official project.

Why crowi-plus?

Check it out all additional features from here.

Quick Start for Production

Using Heroku

  1. Go to https://heroku.com/deploy
  2. (Optional) 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
  • MongoDB 3.x

See confirmed versions.

Optional Dependencies

  • Redix 3.x
  • ElasticSearch 5.x
    • Japanese (kuromoji) Analysis plugin
    • ICU Analysis Plugin

Start

Build and run the app

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

DON'T USE npm install, use yarn instead.

If you launch crowi-plus with Redis and ElasticSearch, add environment variables before npm start like following:

export MONGO_URI=mongodb://MONGO_HOST:MONGO_PORT/crowi
export REDIS_URL=redis://REDIS_HOST:REDIS_PORT/crowi
export ELASTICSEARCH_URI=http://ELASTICSEARCH_HOST:ELASTICSEARCH_PORT/crowi
npm start

For more info, check the official documents.

Command details

|command|desc| |--|--| |npm run build:prod|Build the client| |npm run server:prod|Launch the server| |npm start|Invoke npm run build:prod and npm run server:prod|

Upgrade

git pull
yarn
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

Getting Started to Develop

Build and Running the app

  1. clone this repository
  2. yarn global add npm@4 to install required global dependencies
  3. yarn to install all dependencies
    • DON'T USE npm install
  4. npm run build to build client app
  5. 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.

For more info, read Developers Guide on Wiki.

Documentation

Contributing

Found a Bug?

If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Missing a Feature?

You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it. Please consider what kind of change it is:

  • For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
  • Small Features can be crafted and directly submitted as a Pull Request.

Language

Write issues and PRs in English or Japanese.

Discussion

If you have something to ask or want to discuss, join to our Slack team and talk about anything, anytime.

License

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