説明なし

Yuki Takei 650eec2bf9 update docs 1 年間 前
.changeset 69b0873d7a Merge branch 'master' into feat/154783-create-vector-store-file-for-each-divided-chunk 1 年間 前
.devcontainer 7ca7fd273c pull lfs files with turbo 1 年間 前
.github dce0b918de revert ci-app-@prod.yml 1 年間 前
.vscode fd14bf7f6e update launch.json 1 年間 前
apps 64847e0fd1 update documents 1 年間 前
bin 038f2363d0 Omit Cypress 1 年間 前
packages bd7d6dbbae Merge branch 'master' into support/typescriptize-access-token-parser 1 年間 前
.editorconfig 2d42c72e58 add .editorconfig 9 年 前
.eslintignore d694b3cfe0 organize lint settings 4 年 前
.eslintrc.js 54891b698c enable @typescript-eslint/no-explicit-any 1 年間 前
.gitattributes 0b5a255c5d support woff2 with LFS 2 年 前
.gitignore 7bfb1ac5db clean code 1 年間 前
.markdownlint.yml 1bdb9a077d organize packages 4 年 前
.npmrc 9615e010b5 migrate to pnpm 1 年間 前
.prettierrc 4c699fe833 apply stylelint 7 年 前
.stylelintrc.json 6bc8278661 use stylelint-config-recommended-scss 1 年間 前
.swcrc 68344cfd90 use swc for test 3 年 前
CHANGELOG.md 64847e0fd1 update documents 1 年間 前
LICENSE 282f6c3101 Update LICENSE 8 年 前
README.md 650eec2bf9 update docs 1 年間 前
README_JP.md 650eec2bf9 update docs 1 年間 前
SECURITY.md 4a1824411a fix slackin url 2 年 前
THIRD-PARTY-NOTICES.md 5853e39488 add License Notice for Source Han Code JP 2 年 前
package.json 72f85778af reorganize dependencies 1 年間 前
pnpm-lock.yaml fb98a3c626 Merge pull request #9323 from weseek/support/use-pnpm-deploy-instead-of-turbo-prune 1 年間 前
pnpm-workspace.yaml 9615e010b5 migrate to pnpm 1 年間 前
tsconfig.base.json 8ce0e46945 update module settings 1 年間 前
turbo.json 47f1e75e01 update version scripts 1 年間 前
vitest.workspace.mts c938688673 tream vitest config file as an ESM 1 年間 前

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 v18.x or v20.x
  • npm 6.x
  • pnpm 9.x
  • Turborepo
  • MongoDB 6.0 or above

Optional Dependencies

Command details

command desc
npm run app:build Build GROWI app client
npm run app:server Launch GROWI app server
npm run start Invoke npm run app:build and npm run 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