Keine Beschreibung

Yuki Takei 7102fcc01c Merge branch 'master' into dev/7.0.x vor 2 Jahren
.devcontainer 4742265244 modify container and port settings for devcontainer vor 2 Jahren
.github a08a96b1ac set lfs: true for build-prod vor 2 Jahren
.vscode 1fb1f81e72 add vitest configuration to launch.json (but does not work yet) vor 2 Jahren
_obsolete d44f2ab3a2 move the hackmd package under _obsolete vor 2 Jahren
apps 7102fcc01c Merge branch 'master' into dev/7.0.x vor 2 Jahren
bin 3a5398fd69 omit shipjs vor 2 Jahren
packages 7102fcc01c Merge branch 'master' into dev/7.0.x vor 2 Jahren
.editorconfig 2d42c72e58 add .editorconfig vor 9 Jahren
.eslintignore d694b3cfe0 organize lint settings vor 4 Jahren
.eslintrc.js 5c6de6b07c set `globals: true` vor 2 Jahren
.gitattributes 0b5a255c5d support woff2 with LFS vor 2 Jahren
.gitignore 762565652b WIP: rewrite Dockerfile with turbo prune vor 3 Jahren
.markdownlint.yml 1bdb9a077d organize packages vor 4 Jahren
.mergify.yml ae03a6eee4 update .mergify.yml vor 2 Jahren
.prettierrc 4c699fe833 apply stylelint vor 7 Jahren
.stylelintrc.json b696211bf4 configure postcss-scss vor 4 Jahren
.swcrc 68344cfd90 use swc for test vor 3 Jahren
CHANGELOG.md 6d65fae75f update docs vor 2 Jahren
LICENSE 282f6c3101 Update LICENSE vor 8 Jahren
README.md 02bd300a85 Merge branch 'master' into dev/7.0.x vor 2 Jahren
README_JP.md 02bd300a85 Merge branch 'master' into dev/7.0.x vor 2 Jahren
SECURITY.md 4a1824411a fix slackin url vor 2 Jahren
THIRD-PARTY-NOTICES.md 5853e39488 add License Notice for Source Han Code JP vor 2 Jahren
package.json 7102fcc01c Merge branch 'master' into dev/7.0.x vor 2 Jahren
tsconfig.base.json d2fd2bd66d update tsconfig settings vor 2 Jahren
turbo.json 733ddaa195 devide turbo.json vor 2 Jahren
yarn.lock 7102fcc01c Merge branch 'master' into dev/7.0.x vor 2 Jahren

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