Tml 11 #77
Tml 11 #77
Conversation
WalkthroughThe recent updates focus on refining Git hooks, enhancing Docker configurations, and modifying project dependencies across various packages. Key changes include transitioning from Typescript + Vue to React Typescript + Flutter, updating dependency versions, and restructuring commands and scripts for better project management and development workflows. Changes
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 Configration 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: 2
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
bun.lockbis excluded by!bun.lockb
Files selected for processing (15)
- .moon/hooks/commit-msg.sh (1 hunks)
- .moon/hooks/post-checkout.sh (1 hunks)
- .moon/hooks/pre-commit.sh (1 hunks)
- .moon/hooks/pre-push.sh (1 hunks)
- .moon/hooks/prepare-commit-msg.sh (1 hunks)
- .moon/tasks/typescript.yml (1 hunks)
- Makefile.toml (2 hunks)
- README.md (1 hunks)
- apps/api/package.json (1 hunks)
- apps/handbook/3.products/1.techmely.md (1 hunks)
- apps/web/package.json (4 hunks)
- docker/docker-compose.yml (2 hunks)
- packages/design-system/package.json (1 hunks)
- packages/hono/package.json (1 hunks)
- scripts/docker.toml (1 hunks)
Files skipped from review due to trivial changes (11)
- .moon/hooks/commit-msg.sh
- .moon/hooks/post-checkout.sh
- .moon/hooks/pre-commit.sh
- .moon/hooks/pre-push.sh
- .moon/hooks/prepare-commit-msg.sh
- .moon/tasks/typescript.yml
- apps/api/package.json
- apps/web/package.json
- packages/design-system/package.json
- packages/hono/package.json
- scripts/docker.toml
Additional Context Used
LanguageTool (18)
README.md (9)
Near line 46: There seems to be a noun/verb agreement error. Did you mean “builds” or “built”?
Context: ...w ### Tech docs overview This project build with all my loves + the supportive frie...
Near line 67: Unpaired symbol: ‘[’ seems to be missing
Context: ...ever you want! - Kibana Search Engine smart se...
Near line 88: The adverb ‘always’ is usually put before the verb ‘project’.
Context: ...omeJs...) + Checklist Guideline to help project always in high quality - Production deployment...
Near line 88: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ist Guideline to help project always in high quality - Production deployments—zero-setup pus...
Near line 95: The pronoun ‘we’ must be used with a non-third-person form of a verb.
Context: ...te in RUST to automate all the tasks we needs in this project - Use [Consul](http...
Near line 97: When ‘Framework-Agnostic’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...edible features like Auto Import and Framework Agnostic - Use Git Workflow + **Semantic co...
Near line 99: Did you mean “be notified”?
Context: ...+ review code! - Spell checker will notified once there had typos - Have a lot of **...
Near line 101: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...g/transforming data - Testing - All feature have Unit + UI + e2e testing(mocking DB...
Near line 105: Possible subject-verb agreement error.
Context: ... their permissions This project mainly write with React Typescript + Flutter + Rust,...apps/handbook/3.products/1.techmely.md (9)
Near line 3: You might be missing the article “a” here.
Context: # Techmely ## How to run project 1. Install depsbun install1. Run w...
Near line 6: Nowadays, it’s more common to write this as one word.
Context: ...t 1. Install depsbun install1. Run web site + api with commandbun run dev1. Hav...
Near line 6: Possible missing comma found.
Context: ...bun install1. Run web site + api with commandbun run dev` 1. Have fun with that. #...
Near line 11: Possible missing preposition found.
Context: ...cones.js.org/collection/all` and search what you needs. 2. Copy the symbol of icons ...
Near line 11: The pronoun ‘you’ must be used with a non-third-person form of a verb.
Context: ...org/collection/all` and search what you needs. 2. Copy the symbol of icons 3. If your...
Near line 13: Did you mean “list of icons”?
Context: ...just specific for one page --> Create a list icons for that page in/public/svgfolder -...
Near line 14: You might be missing the article “the” here.
Context: ...n is a common icon, can use anywhere in app --> add to the last item on `public/svg...
Near line 17: The phrase ‘The decided of’ is not correct. Use a noun, not an adjective, between ‘The’ and ‘of’.
Context: ...nent to expose the icon on view ## The decided of technical to fit with the business ...
Near line 21: A verb (‘be’ or ‘have’) is missing before the past participle.
Context: ...log post - With the research --> We chosen the width is around 70~80 characters de...
Additional comments not posted (3)
docker/docker-compose.yml (2)
5-5: Updated PostgreSQL image to16.3.0. This is a good practice to keep dependencies up-to-date.
33-33: Corrected command typo in MinIO configuration to properly set bucket policies.Makefile.toml (1)
5-14: Commented out several script paths and addedscripts/docker.toml. Ensure that the disabled scripts are not required for current build operations.Verification successful
Commented-out scripts in
Makefile.tomlare only referenced within the same file and do not appear to be required for current build operations. This supports the decision to comment them out.
api.tomlgenerate.tomlmigration.tomlmobile.tomlprotobuf.tomlenv.tomltests.tomltool.tomlweb.tomlScripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that the commented-out scripts are not required for the build. # Test: Check if there are any build failures or missing functionalities due to the commented-out scripts. echo "Check build logs and functionalities for any issues related to the scripts commented out in Makefile.toml."Length of output: 222
Script:
#!/bin/bash # Search for references to the commented-out scripts in the codebase # List of scripts that were commented out scripts=("api.toml" "generate.toml" "migration.toml" "mobile.toml" "protobuf.toml" "env.toml" "tests.toml" "tool.toml" "web.toml") # Loop through each script and use ripgrep to search for references in the codebase for script in "${scripts[@]}"; do echo "Searching for references to $script in the codebase:" rg --files-with-matches "$script" || echo "No references found for $script" doneLength of output: 1980
| # Techmely | ||
|
|
||
| ## How to run project | ||
|
|
||
| 1. Install deps `bun install` | ||
| 1. Run web site + api with command `bun run dev` | ||
| 1. Have fun with that. | ||
|
|
||
| ## How to get the icons for project? | ||
|
|
||
| 1. Go to `https://icones.js.org/collection/all` and search what you needs. | ||
| 2. Copy the symbol of icons | ||
| 3. If your icon just specific for one page --> Create a list icons for that page in `/public/svg` folder --> Add page name, EX: post.svg | ||
| 4. If your icon is a common icon, can use anywhere in app --> add to the last item on `public/svg/common.svg` | ||
| 5. Use `SvgUse` component to expose the icon on view | ||
|
|
||
| ## The decided of technical to fit with the business | ||
|
|
||
| 1. The width of detail blog post | ||
|
|
||
| - With the research --> We chosen the width is around 70~80 characters depends on the user-device width + The main language is LATIN(Vietnamese + English). | ||
| - So the width is `34rem` to `38rem`. | ||
|
|
||
| Here is some research paper: | ||
|
|
||
| - <https://baymard.com/blog/line-length-readability> | ||
|
|
||
| 2. | ||
|
|
||
| ## Thirst party API | ||
|
|
||
| - <https://developers.google.com/youtube/v3/docs/?apix=true> | ||
|
|
||
| ## Deployment | ||
|
|
||
| ### Self-host Docker Deployment | ||
|
|
||
| 1. checkout source `git clone https://github.com/techmely/techmely.git` | ||
| 1. got into new source dir: `cd tech` | ||
| 1. build Docker image: `docker build .` | ||
| 1. create local storage directory for settings: `mkdir tml-storage` | ||
| 1. adjust permissions of storage dir: `sudo chown 911:911 ./tml-storage` | ||
| 1. start container: `docker-compose up -d` | ||
|
|
||
| ```sh | ||
| git clone https://github.com/techmely/techmely.git | ||
| cd techmely | ||
| bun run docker.build # build Docker image for all app | ||
| bun run docker.storage # create local storage directory + adjust permissions of storage dir | ||
| bun run docker.up # Start container - Enjoy | ||
| ``` |
There was a problem hiding this comment.
Several grammatical improvements needed:
- Line 3: Add "a" before "project".
- Line 6: Change "web site" to "website".
- Line 11: Change "what you needs" to "what you need".
- Line 13: Change "Create a list icons" to "Create a list of icons".
- Line 14: Add "the" before "app".
- Line 17: Change "The decided of" to "The decision of".
- Line 21: Change "We chosen" to "We have chosen".
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.
| # Techmely | |
| ## How to run project | |
| 1. Install deps `bun install` | |
| 1. Run web site + api with command `bun run dev` | |
| 1. Have fun with that. | |
| ## How to get the icons for project? | |
| 1. Go to `https://icones.js.org/collection/all` and search what you needs. | |
| 2. Copy the symbol of icons | |
| 3. If your icon just specific for one page --> Create a list icons for that page in `/public/svg` folder --> Add page name, EX: post.svg | |
| 4. If your icon is a common icon, can use anywhere in app --> add to the last item on `public/svg/common.svg` | |
| 5. Use `SvgUse` component to expose the icon on view | |
| ## The decided of technical to fit with the business | |
| 1. The width of detail blog post | |
| - With the research --> We chosen the width is around 70~80 characters depends on the user-device width + The main language is LATIN(Vietnamese + English). | |
| - So the width is `34rem` to `38rem`. | |
| Here is some research paper: | |
| - <https://baymard.com/blog/line-length-readability> | |
| 2. | |
| ## Thirst party API | |
| - <https://developers.google.com/youtube/v3/docs/?apix=true> | |
| ## Deployment | |
| ### Self-host Docker Deployment | |
| 1. checkout source `git clone https://github.com/techmely/techmely.git` | |
| 1. got into new source dir: `cd tech` | |
| 1. build Docker image: `docker build .` | |
| 1. create local storage directory for settings: `mkdir tml-storage` | |
| 1. adjust permissions of storage dir: `sudo chown 911:911 ./tml-storage` | |
| 1. start container: `docker-compose up -d` | |
| ```sh | |
| git clone https://github.com/techmely/techmely.git | |
| cd techmely | |
| bun run docker.build # build Docker image for all app | |
| bun run docker.storage # create local storage directory + adjust permissions of storage dir | |
| bun run docker.up # Start container - Enjoy | |
| ``` | |
| # Techmely | |
| ## How to run a project | |
| 1. Install deps `bun install` | |
| 1. Run website + api with command `bun run dev` | |
| 1. Have fun with that. | |
| ## How to get the icons for project? | |
| 1. Go to `https://icones.js.org/collection/all` and search what you need. | |
| 2. Copy the symbol of icons | |
| 3. If your icon just specific for one page --> Create a list of icons for that page in `/public/svg` folder --> Add page name, EX: post.svg | |
| 4. If your icon is a common icon, can use anywhere in the app --> add to the last item on `public/svg/common.svg` | |
| 5. Use `SvgUse` component to expose the icon on view | |
| ## The decision of technical to fit with the business | |
| 1. The width of detail blog post | |
| - With the research --> We have chosen the width is around 70~80 characters depends on the user-device width + The main language is LATIN(Vietnamese + English). | |
| - So the width is `34rem` to `38rem`. | |
| Here is some research paper: | |
| - <https://baymard.com/blog/line-length-readability> | |
| 2. | |
| ## Thirst party API | |
| - <https://developers.google.com/youtube/v3/docs/?apix=true> | |
| ## Deployment | |
| ### Self-host Docker Deployment | |
| 1. checkout source `git clone https://github.com/techmely/techmely.git` | |
| 1. got into new source dir: `cd tech` | |
| 1. build Docker image: `docker build .` | |
| 1. create local storage directory for settings: `mkdir tml-storage` | |
| 1. adjust permissions of storage dir: `sudo chown 911:911 ./tml-storage` | |
| 1. start container: `docker-compose up -d` | |
| ```sh | |
| git clone https://github.com/techmely/techmely.git | |
| cd techmely | |
| bun run docker.build # build Docker image for all app | |
| bun run docker.storage # create local storage directory + adjust permissions of storage dir | |
| bun run docker.up # Start container - Enjoy |
</details>
<!-- suggestion_end -->
<!-- This is an auto-generated comment by CodeRabbit -->
| This project mainly write with React Typescript + Flutter + Rust, so you should learn it to contribute easier 🌷 | ||
|
|
||
| ## How to run project | ||
| ### Setup + Run projects | ||
|
|
||
| 1. Install deps `bun install` | ||
| 1. Run web site + api with command `bun run dev` | ||
| 1. Have fun with that. | ||
|
|
||
| ## How to get the icons for project? | ||
|
|
||
| 1. Go to `https://icones.js.org/collection/all` and search what you needs. | ||
| 2. Copy the symbol of icons | ||
| 3. If your icon just specific for one page --> Create a list icons for that page in `/public/svg` folder --> Add page name, EX: post.svg | ||
| 4. If your icon is a common icon, can use anywhere in app --> add to the last item on `public/svg/common.svg` | ||
| 5. Use `SvgUse` component to expose the icon on view | ||
|
|
||
| ## The decided of technical to fit with the business | ||
|
|
||
| 1. The width of detail blog post | ||
|
|
||
| - With the research --> We chosen the width is around 70~80 characters depends on the user-device width + The main language is LATIN(Vietnamese + English). | ||
| - So the width is `34rem` to `38rem`. | ||
|
|
||
| Here is some research paper: | ||
|
|
||
| - <https://baymard.com/blog/line-length-readability> | ||
|
|
||
| 2. | ||
|
|
||
| ## Thirst party API | ||
|
|
||
| - <https://developers.google.com/youtube/v3/docs/?apix=true> | ||
|
|
||
| ## Deployment | ||
|
|
||
| ### Self-host Docker Deployment | ||
|
|
||
| 1. checkout source `git clone https://github.com/techmely/techmely.git` | ||
| 1. got into new source dir: `cd tech` | ||
| 1. build Docker image: `docker build .` | ||
| 1. create local storage directory for settings: `mkdir tml-storage` | ||
| 1. adjust permissions of storage dir: `sudo chown 911:911 ./tml-storage` | ||
| 1. start container: `docker-compose up -d` | ||
|
|
||
| ```sh | ||
| git clone https://github.com/techmely/techmely.git | ||
| cd techmely | ||
| bun run docker.build # build Docker image for all app | ||
| bun run docker.storage # create local storage directory + adjust permissions of storage dir | ||
| bun run docker.up # Start container - Enjoy | ||
| ``` | ||
| Go to document "apps/handbook/3.products/1.techmely.md" or `https://www.teams.techmely.com/products/techmely` |
There was a problem hiding this comment.
Updated technology stack and setup instructions. Consider the following grammatical corrections for clarity:
- Line 105: Change "write" to "written".
- Line 109: Add "the" before "document".
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.
| This project mainly write with React Typescript + Flutter + Rust, so you should learn it to contribute easier 🌷 | |
| ## How to run project | |
| ### Setup + Run projects | |
| 1. Install deps `bun install` | |
| 1. Run web site + api with command `bun run dev` | |
| 1. Have fun with that. | |
| ## How to get the icons for project? | |
| 1. Go to `https://icones.js.org/collection/all` and search what you needs. | |
| 2. Copy the symbol of icons | |
| 3. If your icon just specific for one page --> Create a list icons for that page in `/public/svg` folder --> Add page name, EX: post.svg | |
| 4. If your icon is a common icon, can use anywhere in app --> add to the last item on `public/svg/common.svg` | |
| 5. Use `SvgUse` component to expose the icon on view | |
| ## The decided of technical to fit with the business | |
| 1. The width of detail blog post | |
| - With the research --> We chosen the width is around 70~80 characters depends on the user-device width + The main language is LATIN(Vietnamese + English). | |
| - So the width is `34rem` to `38rem`. | |
| Here is some research paper: | |
| - <https://baymard.com/blog/line-length-readability> | |
| 2. | |
| ## Thirst party API | |
| - <https://developers.google.com/youtube/v3/docs/?apix=true> | |
| ## Deployment | |
| ### Self-host Docker Deployment | |
| 1. checkout source `git clone https://github.com/techmely/techmely.git` | |
| 1. got into new source dir: `cd tech` | |
| 1. build Docker image: `docker build .` | |
| 1. create local storage directory for settings: `mkdir tml-storage` | |
| 1. adjust permissions of storage dir: `sudo chown 911:911 ./tml-storage` | |
| 1. start container: `docker-compose up -d` | |
| ```sh | |
| git clone https://github.com/techmely/techmely.git | |
| cd techmely | |
| bun run docker.build # build Docker image for all app | |
| bun run docker.storage # create local storage directory + adjust permissions of storage dir | |
| bun run docker.up # Start container - Enjoy | |
| ``` | |
| Go to document "apps/handbook/3.products/1.techmely.md" or `https://www.teams.techmely.com/products/techmely` | |
| This project is mainly written with React Typescript + Flutter + Rust, so you should learn it to contribute easier 🌷 | |
| ### Setup + Run projects | |
| Go to the document "apps/handbook/3.products/1.techmely.md" or `https://www.teams.techmely.com/products/techmely` |
Summary by CodeRabbit
New Features
Makefile.tomlfor various operations including linting, building, testing, and Docker.docker.tomlfor running Docker containers in detached mode.Bug Fixes
docker-compose.ymlfor setting MinIO policy.Documentation
techmely.md.Refactor
.moon/hooksto reference new script paths for Git operations.Chores
package.jsonfiles across multiple apps and packages.Style
Tests
Revert