Skip to content

Latest commit

 

History

History
147 lines (103 loc) · 6.73 KB

README.md

File metadata and controls

147 lines (103 loc) · 6.73 KB

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