No Description

Sotaro KARASAWA 598f7c5e27 Update circle.yml (to notify gitter.im) 10 years ago
bin c3fb23a3d8 Fix models path and internal API in string replacer 11 years ago
lib 346fc9b833 Fix: like and seenUsers cannot update 10 years ago
public d5a7a96375 delete unused file 11 years ago
resource 5e3323b14b Fix responsive style on edit 10 years ago
test e22ba2ae68 Add User test and refactor test utils 10 years ago
tmp a820bcb896 Add .gitignore to keep tmp/googlecache dir 11 years ago
.gitignore c0f47c5f82 Re:Crowi 11 years ago
.jshintrc c0f47c5f82 Re:Crowi 11 years ago
CHANGES.md 760a7f8d87 Update dependencies 10 years ago
LICENSE 8069792e45 Move license terms to LICENSE file 11 years ago
Procfile c0f47c5f82 Re:Crowi 11 years ago
README.md 760a7f8d87 Update dependencies 10 years ago
app.js 7010c3c296 Refactoring application structure 11 years ago
app.json 760a7f8d87 Update dependencies 10 years ago
bower.json 8fb5fa71c4 Implement file upload (with only nominal scenarios yet) 10 years ago
circle.yml 598f7c5e27 Update circle.yml (to notify gitter.im) 10 years ago
gulpfile.js 8fb5fa71c4 Implement file upload (with only nominal scenarios yet) 10 years ago
package.json 760a7f8d87 Update dependencies 10 years ago

README.md

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.

Dependencies

  • Node.js (4.2.x)
  • MongoDB
  • Redis (optional)
  • Amazon S3
  • Facebook Application (optional)
  • Google Project (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.
  • PASSWORD_SEED: A password seed is used by password hash generator.
  • SECRET_TOKEN: A secret key for verifying the integrity of signed cookies.

License

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