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

Yuki Takei 1a08ca1fd4 use NoEmitOnErrorPlugin instead of NoErrorPlugin преди 9 години
bin ab7087512b Added search util преди 10 години
config 1a08ca1fd4 use NoEmitOnErrorPlugin instead of NoErrorPlugin преди 9 години
lib 06b5a3ebc0 modify setup orders of server(to ensure that setting routes is at last) преди 9 години
local_modules 0bba632df5 Remove bluebird require преди 9 години
locales 0ecc7d7653 Update преди 9 години
public fdf992adde inject js to server's html templates преди 9 години
resource d0ada98ea0 impl HMR with webpack преди 9 години
test cc193ff39d Merge branch 'wip-v1.6' into support-i18n преди 9 години
tmp 98e80676bd Fix for multer 1.2 преди 9 години
.babelrc 706cb9e6ad tmp преди 10 години
.editorconfig 2d42c72e58 add .editorconfig преди 9 години
.gitignore fdf992adde inject js to server's html templates преди 9 години
.jshintrc c0f47c5f82 Re:Crowi преди 11 години
CHANGES.md 16dc7c6844 CHANGES, README updates преди 9 години
LICENSE 8069792e45 Move license terms to LICENSE file преди 11 години
Procfile c0f47c5f82 Re:Crowi преди 11 години
README.md 3f88b589c7 Merge pull request #3 from yuki-takei/master преди 9 години
app.js 06b5a3ebc0 modify setup orders of server(to ensure that setting routes is at last) преди 9 години
app.json 32f39265d4 Add bonsai преди 10 години
circle.yml b9a8ba555d Prepare to start 1.6.0 преди 9 години
gulpfile.js 0024827b44 Merge branch 'master' into migrate-to-webpack2 преди 9 години
package.json d0ada98ea0 impl HMR with webpack преди 9 години
webpack.config.js 750ea3d040 WIP: constructing webpack.common.config.js преди 9 години

README.md

Crowi

Crowi - The Simple & Powerful Communication Tool Based on Wiki

Deploy

Circle CI

Crowi is:

  • Easy to edit and share,
  • Markdown supported,
  • Useful timeline list view,
  • Fast.

Install

Install dependencies and build CSS and JavaScript:

$ npm install

More info are here.

WARNING

Don't use master branch because it is unstable but use released tag version expect when you want to contribute the project. master branch is prepared for v1.6. See here to know further info.

Dependencies

  • Node.js (6.x)
  • MongoDB
  • Elasticsearch (optional) (Doc is here)
  • Redis (optional)
  • Amazon S3 (optional)
  • Google Project (optional)
  • Slack App (optional)

Start Up on Local

Crowi is designed setting up to Heroku or some PaaS, but you can start up Crowi with ENV parameter on your local.

$ PASSWORD_SEED=somesecretstring MONGO_URI=mongodb://username:password@localhost/crowi node app.js

Environment

  • PORT: Server port. default: 3000.
  • NODE_ENV: production OR development.
  • MONGO_URI: URI to connect MongoDB. This parameter is also by MONGOHQ_URL OR MONGOLAB_URI.
  • REDIS_URL: URI to connect Redis (to session store). This parameter is also by REDISTOGO_URL.
  • ELASTICSEARCH_URI: URI to connect Elasticearch.
  • PASSWORD_SEED: A password seed is used by password hash generator.
  • SECRET_TOKEN: A secret key for verifying the integrity of signed cookies.
  • FILE_UPLOAD: aws (default), local, none

(Opt.) Install Plugins

Install plugins from github:

$ npm run install-plugin https://github.com/sopmeone/crowi-plugin-something.git

Modify plugin/plugin.js:

const plugins = [
  require('crowi-plugin-something')
]

Build plugins:

$ npm run webpack:plugin

After above process, rebooting Crowi is required.

CAUTION

Plugins are DISABLED in default settings.
Change it on admin page.

License

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