Aucune description

Yuki Takei 8b0af798b0 initialize service instance id after DB is initialized il y a 1 an
.changeset 708c45ab76 add changeset file il y a 1 an
.devcontainer a1a4107b44 Merge branch 'master' into feat/opentelemetry il y a 1 an
.github 03c0a0d563 run CI for app development on pull_request event il y a 1 an
.vscode 0a0f858358 set vitest.filesWatcherInclude for vitest.explorer il y a 1 an
apps 8b0af798b0 initialize service instance id after DB is initialized il y a 1 an
bin 038f2363d0 Omit Cypress il y a 1 an
packages be814104fc update IGrowiInfo interface to include serviceInstanceId and osInfo; modify legacy format conversion to handle appSiteUrlHashed il y a 1 an
.editorconfig 2d42c72e58 add .editorconfig il y a 9 ans
.eslintignore d694b3cfe0 organize lint settings il y a 4 ans
.eslintrc.js 54891b698c enable @typescript-eslint/no-explicit-any il y a 1 an
.gitignore 7bfb1ac5db clean code il y a 1 an
.markdownlint.yml 1bdb9a077d organize packages il y a 4 ans
.npmrc 9615e010b5 migrate to pnpm il y a 1 an
.prettierrc 4c699fe833 apply stylelint il y a 7 ans
.stylelintrc.json 6bc8278661 use stylelint-config-recommended-scss il y a 1 an
.swcrc 68344cfd90 use swc for test il y a 3 ans
CHANGELOG.md 9d3b120b50 Release v7.1.6 il y a 1 an
LICENSE 282f6c3101 Update LICENSE il y a 8 ans
README.md 650eec2bf9 update docs il y a 1 an
README_JP.md 650eec2bf9 update docs il y a 1 an
SECURITY.md 4a1824411a fix slackin url il y a 2 ans
THIRD-PARTY-NOTICES.md 5853e39488 add License Notice for Source Han Code JP il y a 2 ans
package.json 3ec3d3fb28 Bump version il y a 1 an
pnpm-lock.yaml 4863fed41e upgrade opentelemetry packages il y a 1 an
pnpm-workspace.yaml 9615e010b5 migrate to pnpm il y a 1 an
tsconfig.base.json 8ce0e46945 update module settings il y a 1 an
turbo.json e1016cedbf tidy up turbo.json for bumping versions il y a 1 an
vitest.workspace.mts c938688673 tream vitest config file as an ESM il y a 1 an

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