Acasă Explorează Ajutor
Autentificare
wiki
/
weseek__growi
oglindă de https://github.com/weseek/growi
2
0
Bifurcare 0
Fisiere Probleme 0 Wiki

Fără Descriere

Arbore: 2396f6e4cf
Ramuri Etichete
weseek__growi
ZIP TAR.GZ
Yuki Takei 2396f6e4cf WIP: apply bootstrap theme 8 ani în urmă
.github d321bd4060 Update ISSUE_TEMPLATE.md 8 ani în urmă
bin 4eb3ba3f8d BugFix: render emoji with markdown-it-emoji 8 ani în urmă
config 90db36db3e ignore/shrink libs 8 ani în urmă
lib 2396f6e4cf WIP: apply bootstrap theme 8 ani în urmă
local_modules a4ab794cd4 Use POSIX-style paths. 9 ani în urmă
public 9dc9baf722 add agile-admin images 8 ani în urmă
resource 2396f6e4cf WIP: apply bootstrap theme 8 ani în urmă
test e1df29186b BugFix: clear collection before test 8 ani în urmă
tmp b875cefd69 add tmp/plugins dir 9 ani în urmă
.babelrc 48dbe895b2 Get rid of babel-preset-es2015 8 ani în urmă
.editorconfig 2d42c72e58 add .editorconfig 9 ani în urmă
.gitignore 3a493975a8 add webpack-bundle-analyzer 8 ani în urmă
.jshintrc c0f47c5f82 Re:Crowi 11 ani în urmă
.node-dev.json dc3af550d5 use node-dev and easy-livereload 9 ani în urmă
CHANGES.md 0a29174aae :+1: version and update docs 8 ani în urmă
LICENSE 282f6c3101 Update LICENSE 8 ani în urmă
Procfile dbc71db496 fix Procfile 8 ani în urmă
README.md 9b9e05613e Update README.md 8 ani în urmă
THIRD-PARTY-NOTICES.md 1e51baa177 Create THIRD-PARTY-NOTICES.md 8 ani în urmă
app.js 1fc945a4a7 update documents 9 ani în urmă
app.json bf07f3ac41 modify heroku settings 8 ani în urmă
package.json 92906c14fd Merge branch 'master' into rc/3.0.0 8 ani în urmă
webpack.config.js 750ea3d040 WIP: constructing webpack.common.config.js 9 ani în urmă
wercker.yml 34bc8c9126 upgrade node version for wercker ci 8 ani în urmă
yarn.lock 1042d1dd6c Merge branch 'master' into rc/3.0.0 8 ani în urmă

README.md

Crowi

Demo Site

crowi-plus Chat on Slack

wercker status dependencies status devDependencies Status docker pulls MIT License

crowi-plus is a fork of Crowi which is perfectly compatible with the official project.

Why crowi-plus?

  • Pluggable
  • Fast
    • Optimize client-side code chunks by Webpack
    • Optimize the performance when live preview
    • Adopt faster libs(date-fns, pino)
    • Using CDN
  • Secure
    • Prevent XSS (Cross Site Scripting)
    • Upgrade jQuery to 3.x and other insecure libs
    • The official Crowi status is dependencies Status devDependencies Status
  • Convenient
    • Support Authentication with LDAP / Active Directory
    • Slack Incoming Webhooks Integration
    • Miscellaneous features
  • Docker Ready
  • Docker Compose Ready
  • Support IE11 (Experimental)
  • Developer-friendly
    • Less compile time
    • LiveReload separately available by server/client code change
    • Exclude Environment-dependency (confirmed to be developable on Win/Mac/Linux)

Check out all additional features from here.

Quick Start for Production

Using Heroku

  1. Go to https://heroku.com/deploy
  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

Migration Guide from Official Crowi is here.

Dependencies

  • node 6.x (DON'T USE 7.x)
  • npm 4.x (DON'T USE 5.x)
  • yarn
  • MongoDB 3.x

See confirmed versions.

Optional Dependencies

How to start

Build and run the app

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

DO NOT USE npm install, use yarn instead.

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, see Developers Guide and the official documents.

Command details

|command|desc| |--|--| |npm run build:prod|Build the client| |npm run server:prod|Launch the server| |npm start|Invoke npm run build:prod and npm run server:prod|

How to upgrade

git pull
yarn
npm start

How to install plugins

  • Stop server if server is running
  • yarn add to install plugin or npm install --save
    • 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

Examples

yarn add crowi-plugin-lsx
npm start

For more info, see Developers Guide on Wiki.

Documentation

Contribution

For development

Build and Run the app

  1. clone this repository
  2. yarn global add npm@4 to install required global dependencies
  3. yarn to install all dependencies
    • DO NOT USE npm install
  4. npm run build to build client app
  5. npm run server to start the dev server
  6. Access http://0.0.0.0:3000

Found a Bug?

If you found 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, firstly please submit the issue with your proposal to make sure we can confirm it. Please clarify what kind of change you would like to propose.

  • For a Major Feature, firstly open an issue and outline your proposal so it can be discussed. It also allows us to coordinate better, prevent duplication of work and help you to create the change so it can be successfully accepted into the project.
  • Small Features can be created and directly submitted as a Pull Request.

Language

You can write issues and PRs in English or Japanese.

Discussion

If you have questions or suggestions, you can join our Slack team and talk about anything, anytime.

License

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