説明なし

Yuki Takei 8b455860e1 WIP: implement PageCreateButton 2 年 前
.devcontainer c7cbdf29f2 update Dockerfile for devcontainer 2 年 前
.github 02bd300a85 Merge branch 'master' into dev/7.0.x 2 年 前
.vscode 1fb1f81e72 add vitest configuration to launch.json (but does not work yet) 2 年 前
_obsolete d44f2ab3a2 move the hackmd package under _obsolete 2 年 前
apps 8b455860e1 WIP: implement PageCreateButton 2 年 前
bin 3a5398fd69 omit shipjs 2 年 前
packages 4fa4f13ecc refactor flex-expand classes 2 年 前
.editorconfig 2d42c72e58 add .editorconfig 9 年 前
.eslintignore d694b3cfe0 organize lint settings 4 年 前
.eslintrc.js 5c6de6b07c set `globals: true` 2 年 前
.gitattributes 0b5a255c5d support woff2 with LFS 2 年 前
.gitignore 762565652b WIP: rewrite Dockerfile with turbo prune 3 年 前
.markdownlint.yml 1bdb9a077d organize packages 4 年 前
.mergify.yml ae03a6eee4 update .mergify.yml 2 年 前
.prettierrc 4c699fe833 apply stylelint 7 年 前
.stylelintrc.json b696211bf4 configure postcss-scss 4 年 前
.swcrc 68344cfd90 use swc for test 3 年 前
CHANGELOG.md ff6ab212a7 Release v6.2.2 2 年 前
LICENSE 282f6c3101 Update LICENSE 8 年 前
README.md 02bd300a85 Merge branch 'master' into dev/7.0.x 2 年 前
README_JP.md 02bd300a85 Merge branch 'master' into dev/7.0.x 2 年 前
SECURITY.md 4a1824411a fix slackin url 2 年 前
THIRD-PARTY-NOTICES.md 5853e39488 add License Notice for Source Han Code JP 2 年 前
package.json b42a42cb2c Merge branch 'master' into dev/7.0.x 2 年 前
tsconfig.base.json d2fd2bd66d update tsconfig settings 2 年 前
turbo.json 87760059dd modify inputs for app#styles-prebuilt 2 年 前
yarn.lock 0367430b97 add @types/throttle-debounce 2 年 前

README.md

join our Slack team

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 v16.x or v18.x
  • npm 6.x
  • yarn
  • Turborepo
  • MongoDB 4.4 or above

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 Scripts.

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