Sen descrición

Yuki Takei da8237ea26 use ts-deepmerge for the options of sanitize %!s(int64=3) %!d(string=hai) anos
.devcontainer d377c6bff3 use vscode-stylelint %!s(int64=3) %!d(string=hai) anos
.github 12785af81d fix yml syntax %!s(int64=3) %!d(string=hai) anos
.vscode 9c940871ec remove plugin-pukiwiki-like-linker %!s(int64=3) %!d(string=hai) anos
bin bd2f2ff385 fix generate-cypress-spec-arg.js %!s(int64=4) %!d(string=hai) anos
packages da8237ea26 use ts-deepmerge for the options of sanitize %!s(int64=3) %!d(string=hai) anos
.editorconfig 2d42c72e58 add .editorconfig %!s(int64=9) %!d(string=hai) anos
.eslintignore d694b3cfe0 organize lint settings %!s(int64=4) %!d(string=hai) anos
.eslintrc.js 082948c3b9 update eslint rules %!s(int64=3) %!d(string=hai) anos
.gitattributes 5b03044154 fix: Dictionary path of kuromoji invalid when uploaded to server (#4381) %!s(int64=4) %!d(string=hai) anos
.gitignore bbaa77742b merge next.js files to app %!s(int64=3) %!d(string=hai) anos
.markdownlint.yml 1bdb9a077d organize packages %!s(int64=4) %!d(string=hai) anos
.prettierrc 4c699fe833 apply stylelint %!s(int64=7) %!d(string=hai) anos
.stylelintrc.json b696211bf4 configure postcss-scss %!s(int64=4) %!d(string=hai) anos
CHANGELOG.md ff92afa0cf Release v5.1.2 %!s(int64=3) %!d(string=hai) anos
LICENSE 282f6c3101 Update LICENSE %!s(int64=8) %!d(string=hai) anos
README.md eaa0276791 remove dead links from README %!s(int64=4) %!d(string=hai) anos
README_JP.md eaa0276791 remove dead links from README %!s(int64=4) %!d(string=hai) anos
SECURITY.md 9650d68a19 Update SECURITY.md %!s(int64=4) %!d(string=hai) anos
THIRD-PARTY-NOTICES.md 201cad900e remove emojione related codes %!s(int64=3) %!d(string=hai) anos
bump-versions.config.js bd13939b71 fix bump-versions.config.js to update root package.json %!s(int64=4) %!d(string=hai) anos
lerna.json b6baf54325 Bump version %!s(int64=3) %!d(string=hai) anos
package.json da8237ea26 use ts-deepmerge for the options of sanitize %!s(int64=3) %!d(string=hai) anos
tsconfig.base.json b7a7beba01 turn on strictBindCallApply %!s(int64=3) %!d(string=hai) anos
yarn.lock da8237ea26 use ts-deepmerge for the options of sanitize %!s(int64=3) %!d(string=hai) anos

README.md

Documentation / Demo

GROWI

Actions Status docker pulls

demonstration
sample image

Table Of Contents

Features

Quick Start for Production

docker-compose

Helm (Experimental)

On-premise

Migration Guide from Crowi (en/ja) is here.

Configuration

See GROWI Docs: Admin Guide (en/ja).

Environment Variables

See GROWI Docs: Environment Variables (en/ja).

Development

Dependencies

  • Node.js v14.x or v16.x
  • npm 6.x
  • yarn
  • MongoDB 4.x

Optional Dependencies

Command details

command desc
yarn app:build Build GROWI app client
yarn app:server Launch GROWI app server
yarn start Invoke yarn app:build and yarn app:server

For more info, see GROWI Docs: List of npm Commands.

Documentation

Contribution

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 on GitHub

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