Sem descrição

Sotaro KARASAWA 1c2217eb36 Merge branch 'master' into feature-delete-page há 9 anos atrás
bin ab7087512b Added search util há 10 anos atrás
lib 1c2217eb36 Merge branch 'master' into feature-delete-page há 9 anos atrás
local_modules 0f3ebff1da Fix: failed to call getAwdConfig() há 10 anos atrás
public f7c9c60ed4 tmp há 10 anos atrás
resource 877e8339da Error handling. há 10 anos atrás
test 394717a6f8 Add test há 9 anos atrás
tmp a820bcb896 Add .gitignore to keep tmp/googlecache dir há 11 anos atrás
.babelrc 706cb9e6ad tmp há 10 anos atrás
.gitignore 95ecee087b modularized fileupload, add support: local storage há 10 anos atrás
.jshintrc c0f47c5f82 Re:Crowi há 11 anos atrás
CHANGES.md aaf54445db Update README, CHANGES, package.json há 10 anos atrás
LICENSE 8069792e45 Move license terms to LICENSE file há 11 anos atrás
Procfile c0f47c5f82 Re:Crowi há 11 anos atrás
README.md 7cc498472f Merge branch 'master' into feature-search-r há 10 anos atrás
app.js 1a3f0ab6be Change init() and buildServer() interface há 10 anos atrás
app.json 32f39265d4 Add bonsai há 10 anos atrás
circle.yml 02a54ea1ee circle.yml: deploy via heroku pipeline, so remove deploy setting há 10 anos atrás
gulpfile.js 5a47e7c25a fix build há 10 anos atrás
package.json 3c017e253f Add csurf há 10 anos atrás
webpack.config.js 9245874ddf Hide this feature há 10 anos atrás

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.

Dependencies

  • Node.js (4.2.x)
  • MongoDB
  • Elasticsearch (optional)
  • Redis (optional)
  • Amazon S3 (optional)
  • Facebook Application (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.