Skip to content

Latest commit

 

History

History
145 lines (101 loc) · 7.92 KB

README_JP.md

File metadata and controls

145 lines (101 loc) · 7.92 KB

ドキュメント / デモ

GROWI

Actions Status docker pulls

 デモンストレーション
sample image

目次

機能紹介

クイックスタート

docker-compose を使ってはじめる

Helm (Experimental) でデプロイする

オンプレミスではじめる

Crowi からの移行は こちら (en/ja)

設定

GROWI Docs: 管理者ガイド (en/ja)をご覧ください。

環境変数

GROWI Docs: 環境変数 (en/ja) をご覧ください。

開発環境

依存関係

  • Node.js v16.x or v18.x
  • npm 6.x
  • yarn
  • Turborepo
  • MongoDB 4.4 以上

オプションの依存関係

コマンド詳細

コマンド 説明
yarn app:build GROWI app クライアントをビルドします。
yarn app:server GROWI app サーバーを起動します。
yarn start yarn app:buildyarn app:server を呼び出します。

詳しくは GROWI Docs: npm スクリプトリストをご覧ください。

ドキュメント

コントリビューション

バグがありましたか?

ソースコード上でバグを発見されたら、私たちの GitHub 上の Repository にて Issue を作成していただけると助かります。バグを修正して Pull requests を提出していただけるとさらに助かります。

欲しい機能が見あたりませんか?

私たちの GitHub 上の リポジトリに Issue を出して、新しい機能をリクエストすることができます。新機能を実装したい場合も同様に、まずは Issue を提出してください。どのような新機能や変更を提案されるのかを明確にしていただきます。

  • 大規模な機能追加につきましては、Issue を open にした上で、提案された概要を説明していただき、議論できる状態にします。 議論を積み重ねることで、提案内容を双方向的に実装したい機能を整理することができ、実装の重複を防ぐことにもなります。これによって、GROWI への導入がスムーズになります。

  • 小規模な機能追加につきましては、 Issue を作成し、直接 Pull requests を提出してください。

GitHub 上での言語について

Issue と Pull requests の作成は英語・日本語どちらでも受け付けています。

GROWI について話し合いましょう!

質問や提案があれば、私たちの Slack team にぜひご参加ください。 いつでも、どこでも GROWI について議論しましょう!

ライセンス