crowi-plus

by hogewest

GitHub Readme.md

Crowi

Demo Site

crowi-plus Chat on Slack

wercker status dependencies status MIT License

This is crowi-plus that is the fork of Crowi, is perfectly compatible with official, and has been enhanced with the following points:

Quick Start for Production

Using Heroku

  1. Go to https://heroku.com/deploy?template=https%3A%2F%2Fgithub.com%2Fweseek%2Fcrowi-plus
  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

Optional Dependencies

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

Start

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

npm start lauches the server after building the client.

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.

Other commands

command desc npm run build:prod Build the client npm run server:prod Launch the server

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

Dependencies

  • node 6.x (DON'T USE 7.x)
  • npm 4.x
  • yarn
  • following environment is confirmed to work

    $ node -v
    v6.10.0
    
    $ npm -v
    4.6.1
    
    $ yarn --version
    0.24.5

Build and Running the app

  • clone this repository
  • npm install -g npm@4 to install required global dependencies
  • npm install to install all dependencies or yarn
  • npm run build to build client app
  • 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.

List of npm commands

e.g. npm run build

command desc build Same to build:dev build:dev Build the client build:dev:watch Watch and Re-build the client build:prod Build the client for production server Same to server:dev:watch server:dev Launch the server server:dev:watch Watch and Re-start the server server:prod Launch the server for production start run build:prod and server:prod

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.