search

JhumanJ / OpnForm

Beautiful Open-Source Form Builder
https://opnform.com
GNU Affero General Public License v3.0
2.26k stars 303 forks source link

Add Coolify template and 1-click deploy button for OpnForm (Fixes #626) #628

Open aybanda opened 1 day ago

aybanda commented 1 day ago

Summary

This pull request adds a Coolify template for deploying OpnForm with a 1-click deploy button.

Changes Made

/claim #626

Related Issue

Fixes #626

Summary by CodeRabbit

coderabbitai[bot] commented 1 day ago

Walkthrough

This pull request introduces several components for deploying the OpnForm application using Docker Compose. It adds a configuration file (template.yml) that defines services such as opnform-api, db, redis, and opnform-ingress. Additionally, a new documentation file (1-click-deploy-button.md) provides instructions for a one-click deployment process via Coolify. A shell script (setup-env-coolify.sh) is also included to automate the creation of a .env file for the deployment, ensuring necessary environment variables are set.

Changes

File Change Summary
coolify-template/template.yml Introduced a Docker Compose configuration for OpnForm with services: opnform-api, db, redis, opnform-ingress.
docs/1-click-deploy-button.md Added documentation for one-click deployment of OpnForm using Coolify, detailing services and environment variables.
scripts/setup-env-coolify.sh Created a script to automate the generation of a .env file with necessary environment variables for deployment.

Assessment against linked issues

Objective Addressed Explanation
Coolify Template: Adapt Docker setup for Coolify (626) ✅
.env File Generator Script for Coolify (626) ✅
1-Click Deploy Button integration (626) ✅

Possibly related issues

Poem

In the garden where we play,
A new template blooms today. 🌼
With Docker's charm and Coolify's grace,
OpnForm finds its perfect place.
One-click joy, oh what a sight,
Deploy with ease, everything feels right! 🐇✨

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between 5cd9885185fd28cc7d3688a47b148da811221d87 and 90e2fbd6ed918f48e1d6f9cb2ca5eac7dfdf8ed1.
📒 Files selected for processing (3) * `coolify-template/template.yml` (1 hunks) * `docs/1-click-deploy-button.md` (1 hunks) * `scripts/setup-env-coolify.sh` (1 hunks)
✅ Files skipped from review due to trivial changes (2) * coolify-template/template.yml * scripts/setup-env-coolify.sh
🧰 Additional context used
🪛 LanguageTool
docs/1-click-deploy-button.md [uncategorized] ~28-~28: Loose punctuation mark. Context: ...o configure the services: - `DB_HOST`: Hostname for the database service. - ... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~29-~29: Loose punctuation mark. Context: ...r the database service. - `REDIS_HOST`: Hostname for the Redis service. - `DB... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~30-~30: Loose punctuation mark. Context: ...for the Redis service. - `DB_DATABASE`: Name of the database (default: `forge`)... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~31-~31: Loose punctuation mark. Context: ...se (default: `forge`). - `DB_USERNAME`: Database username (default: `forge`). -... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~32-~32: Loose punctuation mark. Context: ...me (default: `forge`). - `DB_PASSWORD`: Database password (default: `forge`). -... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~33-~33: Loose punctuation mark. Context: ... (default: `forge`). - `DB_CONNECTION`: Database connection type (default: `pgs... (UNLIKELY_OPENING_PUNCTUATION)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.