update deployment in readme

zed-wong commented 2 months ago

Type

Enhancement, Documentation

Description

Enhanced the deployment section in the README to provide more detailed instructions and warnings about potential issues:
- Added a note about the possible insufficiency of Railway's Trial Plan for running the server, suggesting an upgrade.
- Updated the Vercel deployment steps to guide users through filling in environment variables and obtaining a Mixin keystore if they don't already have one.

Changes walkthrough

Relevant files

Documentation

README.md

Update Deployment Instructions in README

README.md

Updated deployment instructions for Railway to include a note on the
potential need for a plan upgrade.

Revised Vercel deployment instructions to include steps for setting
environment variables and obtaining a Mixin keystore.

+2/-6

✨ PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

vercel[bot] commented 2 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
mr-market	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 16, 2024 1:00am

railway-app[bot] commented 2 months ago

This PR is being deployed to Railway 🚅

railway-app[bot] commented 2 months ago

This PR is being deployed to Railway 🚅

github-actions[bot] commented 2 months ago

PR Description updated to latest commit (https://github.com/Hu-Fi/Mr.Market/commit/938e4c152689fab6ac00d86ad3081018e6fab3a5)

github-actions[bot] commented 2 months ago

PR Review

(Review updated until commit https://github.com/Hu-Fi/Mr.Market/commit/df108166a7e89eca121373d7e7a1356f2ec03bdc)

⏱️ Estimated effort to review [1-5]	1, because the PR consists solely of documentation updates in the README.md file, which are straightforward and do not involve complex code changes.
🧪 Relevant tests	No
🔍 Possible issues	No
🔒 Security concerns	No

Code feedback:

✨ Review tool usage guide:

**Overview:** The `review` tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be [added](https://pr-agent-docs.codium.ai/tools/review/#general-configurations) by configuring the tool. The tool can be triggered [automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) every time a new PR is opened, or can be invoked manually by commenting on any PR. - When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L23) related to the review tool (`pr_reviewer` section), use the following template: ``` /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=... ``` - With a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template: ``` [pr_reviewer] some_config1=... some_config2=... ``` See the review [usage page](https://pr-agent-docs.codium.ai/tools/review/) for a comprehensive guide on using this tool.

github-actions[bot] commented 2 months ago

PR Code Suggestions

Category	Suggestions
Enhancement	Add a guide or link for upgrading the Railway plan to assist users. ___ Consider adding a step-by-step guide or a link to a guide for upgrading the `Trial Plan` on Railway. This will help users who are unfamiliar with the process and ensure a smoother deployment experience. [README.md [80]](https://github.com/Hu-Fi/Mr.Market/pull/155/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R80-R80) ```diff -1. Click button to deploy server on railway. It's possible that the `Trial Plan` of railway doesn't have enough memory to run the server. We suggest to upgrade. +1. Click button to deploy server on railway. It's possible that the `Trial Plan` of railway doesn't have enough memory to run the server. We suggest to upgrade. For a guide on upgrading your plan, see [Upgrading on Railway](https://docs.railway.app/start/upgrading). ```
Transparency	Add a cost warning for upgrading the Railway plan. ___ Include a warning or note about potential costs associated with upgrading from the `Trial` `Plan` on Railway. This transparency can help users make informed decisions. [README.md [80]](https://github.com/Hu-Fi/Mr.Market/pull/155/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R80-R80) ```diff -1. Click button to deploy server on railway. It's possible that the `Trial Plan` of railway doesn't have enough memory to run the server. We suggest to upgrade. +1. Click button to deploy server on railway. It's possible that the `Trial Plan` of railway doesn't have enough memory to run the server. We suggest to upgrade. Note: Upgrading may incur additional costs. ```
Readability	Break down complex deployment steps into sub-steps for better clarity. ___ Break down the deployment steps into smaller, numbered sub-steps to enhance clarity and readability. This can help users follow the deployment process more easily. [README.md [82]](https://github.com/Hu-Fi/Mr.Market/pull/155/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R82-R82) ```diff -2. Click button to deploy interface on vercel, fill the environment variables from railway deployment and mixin keystore. If you don't have a mixin keystore already, go to [Mixin developer dashboard](https://developers.mixin.one/dashboard) to get one. +2. Deploy interface on Vercel: + a. Click button. + b. Fill in the environment variables from the Railway deployment. + c. If you don't have a mixin keystore, visit the [Mixin developer dashboard](https://developers.mixin.one/dashboard) to obtain one. ```
Usability	Provide instructions or a link for filling environment variables during Vercel deployment. ___ Add explicit instructions or a link on how to fill in the environment variables during the Vercel deployment process, especially for users who might be unfamiliar with these settings. [README.md [82]](https://github.com/Hu-Fi/Mr.Market/pull/155/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R82-R82) ```diff -2. Click button to deploy interface on vercel, fill the environment variables from railway deployment and mixin keystore. +2. Click button to deploy interface on vercel. For instructions on how to fill the environment variables, see [Setting Environment Variables in Vercel](https://vercel.com/docs/environment-variables). ```
Support	Add a troubleshooting guide for common deployment issues. ___ Include a troubleshooting section or FAQ for common issues that might arise during the deployment process on Railway and Vercel. This can help users resolve issues without needing to seek external help. [README.md [80-82]](https://github.com/Hu-Fi/Mr.Market/pull/155/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R80-R82) ```diff 1. Click button to deploy server on railway. It's possible that the `Trial Plan` of railway doesn't have enough memory to run the server. We suggest to upgrade. 2. Click button to deploy interface on vercel, fill the environment variables from railway deployment and mixin keystore. +For troubleshooting common issues during deployment, see our [Deployment Troubleshooting Guide](https://example.com/deployment-troubleshooting). ```

✨ Improve tool usage guide:

**Overview:** The `improve` tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered [automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) every time a new PR is opened, or can be invoked manually by commenting on a PR. - When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L78) related to the improve tool (`pr_code_suggestions` section), use the following template: ``` /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=... ``` - With a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template: ``` [pr_code_suggestions] some_config1=... some_config2=... ``` See the improve [usage page](https://pr-agent-docs.codium.ai/tools/improve/) for a comprehensive guide on using this tool.

github-actions[bot] commented 2 months ago

PR Description updated to latest commit (https://github.com/Hu-Fi/Mr.Market/commit/df108166a7e89eca121373d7e7a1356f2ec03bdc)

github-actions[bot] commented 2 months ago

Persistent review updated to latest commit https://github.com/Hu-Fi/Mr.Market/commit/df108166a7e89eca121373d7e7a1356f2ec03bdc

github-actions[bot] commented 2 months ago

PR Code Suggestions

Category	Suggestions
Enhancement	Convert HTML links and images to Markdown syntax for better readability and consistency. ___ Consider using Markdown syntax for links and images instead of HTML for consistency and readability in Markdown files. This change would make the document easier to read and maintain, especially for those familiar with Markdown. [README.md [80]](https://github.com/Hu-Fi/Mr.Market/pull/155/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R80-R80) ```diff -1. Click button to deploy server on railway. +1. Click [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/bveg2P?referralCode=j8dZGz) button to deploy server on railway. ```
Enhancement	Clarify that upgrading the plan may involve additional costs. ___ To avoid potential confusion, explicitly mention that upgrading the plan on Railway may incur additional costs. This transparency can help users make informed decisions. [README.md [80]](https://github.com/Hu-Fi/Mr.Market/pull/155/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R80-R80) ```diff -It's possible that the `Trial Plan` of railway doesn't have enough memory to run the server. We suggest to upgrade. +It's possible that the `Trial Plan` of railway doesn't have enough memory to run the server. We suggest upgrading, which may incur additional costs. ```
Best practice	Remove explicit pixel width from images to enhance responsiveness. ___ It is recommended to avoid specifying explicit pixel widths for images in Markdown to ensure better responsiveness and compatibility across different devices and screen sizes. Instead, control image sizing through CSS or allow it to scale naturally. [README.md [80]](https://github.com/Hu-Fi/Mr.Market/pull/155/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R80-R80) ```diff - +![Deploy on Railway](https://railway.app/button.svg) ```
Security	Remove referral codes from public documents to enhance security and maintainability. ___ To enhance the security and maintainability of the README, avoid using direct referral codes in public documents. Consider providing general links or guiding users on how to obtain their own codes. [README.md [80]](https://github.com/Hu-Fi/Mr.Market/pull/155/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R80-R80) ```diff - + ```
Accessibility	Improve alternative text for images to enhance accessibility. ___ To improve the accessibility of the README, add more descriptive alternative text for images. This helps users who rely on screen readers to understand the content better. [README.md [80]](https://github.com/Hu-Fi/Mr.Market/pull/155/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R80-R80) ```diff - + ```

✨ Improve tool usage guide:

**Overview:** The `improve` tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered [automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) every time a new PR is opened, or can be invoked manually by commenting on a PR. - When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L78) related to the improve tool (`pr_code_suggestions` section), use the following template: ``` /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=... ``` - With a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template: ``` [pr_code_suggestions] some_config1=... some_config2=... ``` See the improve [usage page](https://pr-agent-docs.codium.ai/tools/improve/) for a comprehensive guide on using this tool.

Hu-Fi / Mr.Market