Add a vercel deployment button, and cleanup docs a bit #96
Conversation
Deploying saasstarter with
|
| Latest commit: |
a0962d7
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://e2ddea18.saasstarter.pages.dev |
| Branch Preview URL: | https://vercel-deploy-button.saasstarter.pages.dev |
WalkthroughThe updates to the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant README
participant DeveloperTools
participant Deployment
User->>README: Access documentation
README->>User: Provide clear sections
User->>DeveloperTools: Get setup instructions
DeveloperTools->>User: Offer tools and setup steps
User->>Deployment: Explore hosting options
Deployment->>User: Present deployment choices
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (5)
README.md (5)
140-140: Add a comma before 'and'Use a comma before 'and' if it connects two independent clauses.
- "Use this template": use this Github button if you want to build your own project using CMSaasStarter as a starter template and you aren't planning on contributing work back to the public open source project. + "Use this template": use this Github button if you want to build your own project using CMSaasStarter as a starter template, and you aren't planning on contributing work back to the public open source project.Tools
LanguageTool
[uncategorized] ~140-~140: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...sing CMSaasStarter as a starter template and you aren't planning on contributing wor...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~140-~140: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...on contributing work back to the public open source project. See [Github Docs](https://docs...(EN_COMPOUND_ADJECTIVE_INTERNAL)
140-140: Consider using a hyphen for compound adjectivesIf this is a compound adjective that modifies the following noun, use a hyphen.
- ...back to the public open source project. + ...back to the public open-source project.Tools
LanguageTool
[uncategorized] ~140-~140: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...sing CMSaasStarter as a starter template and you aren't planning on contributing wor...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~140-~140: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...on contributing work back to the public open source project. See [Github Docs](https://docs...(EN_COMPOUND_ADJECTIVE_INTERNAL)
141-141: Use 'to' before 'contribute'The verb "contribute" needs to be in the to-infinitive form.
- "Fork": use this button if you want contribute some or all of your work back to the public open source project. + "Fork": use this button if you want to contribute some or all of your work back to the public open source project.Tools
LanguageTool
[grammar] ~141-~141: The verb “contribute” needs to be in the to-infinitive form.
Context: ...late). - "Fork": use this button if you want contribute some or all of your work back to the pu...(MISSING_TO_BEFORE_A_VERB)
[uncategorized] ~141-~141: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... or all of your work back to the public open source project. It will keep the full commit h...(EN_COMPOUND_ADJECTIVE_INTERNAL)
256-256: Use 'deployment' instead of 'deploy'The word 'deploy' is a verb. Did you mean the noun "deployment"?
- Deploy using Vercel's deploy button: + Deployment using Vercel's deploy button:Tools
LanguageTool
[grammar] ~256-~256: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)?
Context: ...Deploy to Vercel Deploy using Vercel's deploy button: [
262-262: Add a commaA comma might be missing here.
- If you prefer another host you can explore alternatives: + If you prefer another host, you can explore alternatives:Tools
LanguageTool
[uncategorized] ~262-~262: A comma might be missing here.
Context: ...loy Alternatives If you prefer another host you can explore alternatives: - [Svelt...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (9 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~140-~140: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...sing CMSaasStarter as a starter template and you aren't planning on contributing wor...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~140-~140: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...on contributing work back to the public open source project. See [Github Docs](https://docs...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~141-~141: The verb “contribute” needs to be in the to-infinitive form.
Context: ...late). - "Fork": use this button if you want contribute some or all of your work back to the pu...(MISSING_TO_BEFORE_A_VERB)
[uncategorized] ~141-~141: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... or all of your work back to the public open source project. It will keep the full commit h...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~256-~256: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)?
Context: ...Deploy to Vercel Deploy using Vercel's deploy button: [
[uncategorized] ~262-~262: A comma might be missing here.
Context: ...loy Alternatives If you prefer another host you can explore alternatives: - [Svelt...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
Additional comments not posted (3)
README.md (3)
Line range hint
143-159:
LGTM!The instructions for setting up local development are clear and correct.
Tools
LanguageTool
[uncategorized] ~140-~140: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...sing CMSaasStarter as a starter template and you aren't planning on contributing wor...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~140-~140: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...on contributing work back to the public open source project. See [Github Docs](https://docs...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~141-~141: The verb “contribute” needs to be in the to-infinitive form.
Context: ...late). - "Fork": use this button if you want contribute some or all of your work back to the pu...(MISSING_TO_BEFORE_A_VERB)
[uncategorized] ~141-~141: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... or all of your work back to the public open source project. It will keep the full commit h...(EN_COMPOUND_ADJECTIVE_INTERNAL)
Markdownlint
147-147: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Line range hint
159-185:
LGTM!The information about developer tools and CI scripts is clear and correct.
Line range hint
185-217:
LGTM!The instructions for setting up a Supabase project are clear and correct.
Tools
LanguageTool
[uncategorized] ~203-~203: Possible missing comma found.
Context: ...Auth console. For example, for the demo page we added: `https://saasstarter.work/aut...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~203-~203: “to the” seems less likely than “to”.
Context: ...auth/callback` . Also add that same URL to the the “allowed redirect URL” list in the ...(AI_HYDRA_LEO_CP_TO_THE_TO)
[typographical] ~204-~204: After the expression ‘for example’ a comma is usually used.
Context: ...s parameters to your auth callback. For example we added the following for the demo pag...(COMMA_FOR_EXAMPLE)
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (2)
README.md (2)
140-140: Fix the comma usage.Use a comma before ‘and’ if it connects two independent clauses.
- "Use this template": use this Github button if you want to build your own project using CMSaasStarter as a starter template and you aren't planning on contributing work back to the public open source project. + "Use this template": use this Github button if you want to build your own project using CMSaasStarter as a starter template, and you aren't planning on contributing work back to the public open source project.Tools
LanguageTool
[uncategorized] ~140-~140: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...sing CMSaasStarter as a starter template and you aren't planning on contributing wor...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~140-~140: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...on contributing work back to the public open source project. See [Github Docs](https://docs...(EN_COMPOUND_ADJECTIVE_INTERNAL)
140-140: Fix the compound adjective.If this is a compound adjective that modifies the following noun, use a hyphen.
- ...to the public open source project. + ...to the public open-source project.Tools
LanguageTool
[uncategorized] ~140-~140: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...sing CMSaasStarter as a starter template and you aren't planning on contributing wor...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~140-~140: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...on contributing work back to the public open source project. See [Github Docs](https://docs...(EN_COMPOUND_ADJECTIVE_INTERNAL)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (9 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~140-~140: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...sing CMSaasStarter as a starter template and you aren't planning on contributing wor...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~140-~140: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...on contributing work back to the public open source project. See [Github Docs](https://docs...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~141-~141: The verb “contribute” needs to be in the to-infinitive form.
Context: ...late). - "Fork": use this button if you want contribute some or all of your work back to the pu...(MISSING_TO_BEFORE_A_VERB)
[uncategorized] ~141-~141: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... or all of your work back to the public open source project. It will keep the full commit h...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~256-~256: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)?
Context: ...Deploy to Vercel Deploy using Vercel's deploy button: [
Additional comments not posted (5)
README.md (5)
Line range hint
143-158:
LGTM!The instructions for setting up local development are clear and well-structured.
Tools
LanguageTool
[uncategorized] ~140-~140: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...sing CMSaasStarter as a starter template and you aren't planning on contributing wor...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~140-~140: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...on contributing work back to the public open source project. See [Github Docs](https://docs...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~141-~141: The verb “contribute” needs to be in the to-infinitive form.
Context: ...late). - "Fork": use this button if you want contribute some or all of your work back to the pu...(MISSING_TO_BEFORE_A_VERB)
[uncategorized] ~141-~141: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... or all of your work back to the public open source project. It will keep the full commit h...(EN_COMPOUND_ADJECTIVE_INTERNAL)
Markdownlint
147-147: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Line range hint
159-184:
LGTM!The information about developer tools and CI scripts is clear and well-structured.
Line range hint
185-216:
LGTM!The instructions for setting up a Supabase project are clear and well-structured.
Tools
LanguageTool
[duplication] ~203-~203: Possible typo: you repeated a word
Context: ...h/callback` . Also add that same URL to the the “allowed redirect URL” list in the Supa...(ENGLISH_WORD_REPEAT_RULE)
[typographical] ~204-~204: After the expression ‘for example’ a comma is usually used.
Context: ...s parameters to your auth callback. For example we added the following for the demo pag...(COMMA_FOR_EXAMPLE)
Line range hint
217-238:
LGTM!The instructions for setting up Stripe are clear and well-structured.
256-256: Fix the noun form.The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)?
- Deploy using Vercel's deploy button: + Deployment using Vercel's deploy button:Likely invalid or redundant comment.
Tools
LanguageTool
[grammar] ~256-~256: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)?
Context: ...Deploy to Vercel Deploy using Vercel's deploy button: [
|
|
||
| To get started, create your own copy of the project for development. There are two options: | ||
|
|
||
| - "Use this template": use this button if you want to build your own project using CMSaasStarter as a starter template and you aren't planning on contributing work back to the public open source project. See [Github Docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template). | ||
| - "Use this template": use this Github button if you want to build your own project using CMSaasStarter as a starter template and you aren't planning on contributing work back to the public open source project. See [Github Docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template). | ||
| - "Fork": use this button if you want contribute some or all of your work back to the public open source project. It will keep the full commit history, and be easier to create PRs back to CMSaasStarter. |
There was a problem hiding this comment.
Fix the verb form.
The verb “contribute” needs to be in the to-infinitive form.
- "Fork": use this button if you want contribute some or all of your work back to the public open source project.
+ "Fork": use this button if you want to contribute some or all of your work back to the public open-source project.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - "Fork": use this button if you want contribute some or all of your work back to the public open source project. It will keep the full commit history, and be easier to create PRs back to CMSaasStarter. | |
| "Fork": use this button if you want to contribute some or all of your work back to the public open-source project. It will keep the full commit history, and be easier to create PRs back to CMSaasStarter. |
Tools
LanguageTool
[grammar] ~141-~141: The verb “contribute” needs to be in the to-infinitive form.
Context: ...late). - "Fork": use this button if you want contribute some or all of your work back to the pu...(MISSING_TO_BEFORE_A_VERB)
[uncategorized] ~141-~141: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... or all of your work back to the public open source project. It will keep the full commit h...(EN_COMPOUND_ADJECTIVE_INTERNAL)
Part one of #56
Summary by CodeRabbit