暂无描述

Shun Miyazawa 94686f05f4 useSWRxCurrentUserBookmarks -> useSWRxUserBookmarks 2 年之前
.devcontainer eb226b8e56 update mongo image version 2 年之前
.github 2a062d0ead use turbo instead of lerna 2 年之前
.vscode d797083623 reorganize packages 3 年之前
apps 94686f05f4 useSWRxCurrentUserBookmarks -> useSWRxUserBookmarks 2 年之前
bin 5f73b56fef fix fb 2 年之前
packages 6fd62d6669 Release v6.1.0 2 年之前
tools f42abde48d add replacer tool project 3 年之前
.editorconfig 2d42c72e58 add .editorconfig 9 年之前
.eslintignore d694b3cfe0 organize lint settings 4 年之前
.eslintrc.js 082948c3b9 update eslint rules 3 年之前
.gitattributes 0b5a255c5d support woff2 with LFS 2 年之前
.gitignore 762565652b WIP: rewrite Dockerfile with turbo prune 3 年之前
.markdownlint.yml 1bdb9a077d organize packages 4 年之前
.mergify.yml ac7a5e74c8 update .mergify.yml 3 年之前
.prettierrc 4c699fe833 apply stylelint 7 年之前
.stylelintrc.json b696211bf4 configure postcss-scss 4 年之前
.swcrc 68344cfd90 use swc for test 3 年之前
CHANGELOG.md 6fd62d6669 Release v6.1.0 2 年之前
LICENSE 282f6c3101 Update LICENSE 8 年之前
README.md 44c6800530 update README.md 2 年之前
README_JP.md 44c6800530 update README.md 2 年之前
SECURITY.md 9650d68a19 Update SECURITY.md 4 年之前
THIRD-PARTY-NOTICES.md 5853e39488 add License Notice for Source Han Code JP 2 年之前
bump-versions.config.js 68e551d98c update bump-versions.config.js 3 年之前
package.json 6fd62d6669 Release v6.1.0 2 年之前
tsconfig.base.json d797083623 reorganize packages 3 年之前
turbo.json 65e665cc8a upgrade micromark-extension-gfm-table 2 年之前
yarn.lock 380e4419c9 update mongoose 2 年之前

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