بدون توضیح

Sotaro KARASAWA 2ddeff1239 Merge branch 'files-routing' of github.com:crowi/crowi into files-routing 9 سال پیش
bin ab7087512b Added search util 10 سال پیش
lib 2ddeff1239 Merge branch 'files-routing' of github.com:crowi/crowi into files-routing 9 سال پیش
local_modules 6f49fb5dbb Implement file redirector route and cache util 9 سال پیش
locales 0ecc7d7653 Update 9 سال پیش
public 943986dcb9 Fix icons 9 سال پیش
resource 72b7096436 Supported highlighting of phrase search 9 سال پیش
test cc193ff39d Merge branch 'wip-v1.6' into support-i18n 9 سال پیش
tmp 98e80676bd Fix for multer 1.2 9 سال پیش
.babelrc 706cb9e6ad tmp 10 سال پیش
.gitignore 95ecee087b modularized fileupload, add support: local storage 10 سال پیش
.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 16dc7c6844 CHANGES, README updates 9 سال پیش
app.js 1a3f0ab6be Change init() and buildServer() interface 10 سال پیش
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 سال پیش
npm-shrinkwrap.json 2d4b845074 Update express 9 سال پیش
package.json 2d4b845074 Update express 9 سال پیش
webpack.config.js 2854b80d3d modify build settings 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

License

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