@mytechtoday/augment-extensions 0.7.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (483) hide show
  1. package/AGENTS.md +265 -232
  2. package/README.md +956 -771
  3. package/augment-extensions/coding-standards/bash/README.md +196 -196
  4. package/augment-extensions/coding-standards/bash/module.json +163 -163
  5. package/augment-extensions/coding-standards/bash/rules/naming-conventions.md +336 -336
  6. package/augment-extensions/coding-standards/bash/rules/universal-standards.md +289 -289
  7. package/augment-extensions/coding-standards/css/README.md +40 -40
  8. package/augment-extensions/coding-standards/css/examples/css-examples.css +550 -550
  9. package/augment-extensions/coding-standards/css/module.json +44 -44
  10. package/augment-extensions/coding-standards/css/rules/css-modern-features.md +448 -448
  11. package/augment-extensions/coding-standards/css/rules/css-standards.md +492 -492
  12. package/augment-extensions/coding-standards/html/README.md +40 -40
  13. package/augment-extensions/coding-standards/html/examples/html-examples.html +267 -267
  14. package/augment-extensions/coding-standards/html/examples/responsive-layout.html +505 -505
  15. package/augment-extensions/coding-standards/html/module.json +44 -44
  16. package/augment-extensions/coding-standards/html/rules/html-standards.md +349 -349
  17. package/augment-extensions/coding-standards/html-css-js/README.md +194 -194
  18. package/augment-extensions/coding-standards/html-css-js/examples/async-examples.js +487 -487
  19. package/augment-extensions/coding-standards/html-css-js/examples/css-examples.css +550 -550
  20. package/augment-extensions/coding-standards/html-css-js/examples/dom-examples.js +667 -667
  21. package/augment-extensions/coding-standards/html-css-js/examples/html-examples.html +267 -267
  22. package/augment-extensions/coding-standards/html-css-js/examples/javascript-examples.js +612 -612
  23. package/augment-extensions/coding-standards/html-css-js/examples/responsive-layout.html +505 -505
  24. package/augment-extensions/coding-standards/html-css-js/module.json +48 -48
  25. package/augment-extensions/coding-standards/html-css-js/rules/async-patterns.md +515 -515
  26. package/augment-extensions/coding-standards/html-css-js/rules/css-modern-features.md +448 -448
  27. package/augment-extensions/coding-standards/html-css-js/rules/css-standards.md +492 -492
  28. package/augment-extensions/coding-standards/html-css-js/rules/dom-manipulation.md +439 -439
  29. package/augment-extensions/coding-standards/html-css-js/rules/html-standards.md +349 -349
  30. package/augment-extensions/coding-standards/html-css-js/rules/javascript-standards.md +486 -486
  31. package/augment-extensions/coding-standards/html-css-js/rules/performance.md +463 -463
  32. package/augment-extensions/coding-standards/html-css-js/rules/tooling.md +543 -543
  33. package/augment-extensions/coding-standards/js/README.md +46 -46
  34. package/augment-extensions/coding-standards/js/examples/async-examples.js +487 -487
  35. package/augment-extensions/coding-standards/js/examples/dom-examples.js +667 -667
  36. package/augment-extensions/coding-standards/js/examples/javascript-examples.js +612 -612
  37. package/augment-extensions/coding-standards/js/module.json +49 -49
  38. package/augment-extensions/coding-standards/js/rules/async-patterns.md +515 -515
  39. package/augment-extensions/coding-standards/js/rules/dom-manipulation.md +439 -439
  40. package/augment-extensions/coding-standards/js/rules/javascript-standards.md +486 -486
  41. package/augment-extensions/coding-standards/js/rules/performance.md +463 -463
  42. package/augment-extensions/coding-standards/js/rules/tooling.md +543 -543
  43. package/augment-extensions/coding-standards/php/README.md +248 -248
  44. package/augment-extensions/coding-standards/php/examples/api-endpoint-example.php +204 -204
  45. package/augment-extensions/coding-standards/php/examples/cli-command-example.php +206 -206
  46. package/augment-extensions/coding-standards/php/examples/legacy-refactoring-example.php +234 -234
  47. package/augment-extensions/coding-standards/php/examples/web-application-example.php +211 -211
  48. package/augment-extensions/coding-standards/php/examples/woocommerce-extension-example.php +215 -215
  49. package/augment-extensions/coding-standards/php/examples/wordpress-plugin-example.php +189 -189
  50. package/augment-extensions/coding-standards/php/module.json +166 -166
  51. package/augment-extensions/coding-standards/php/rules/api-development.md +480 -480
  52. package/augment-extensions/coding-standards/php/rules/category-configuration.md +332 -332
  53. package/augment-extensions/coding-standards/php/rules/cli-tools.md +472 -472
  54. package/augment-extensions/coding-standards/php/rules/cms-integration.md +561 -561
  55. package/augment-extensions/coding-standards/php/rules/code-quality.md +402 -402
  56. package/augment-extensions/coding-standards/php/rules/documentation.md +425 -425
  57. package/augment-extensions/coding-standards/php/rules/ecommerce.md +627 -627
  58. package/augment-extensions/coding-standards/php/rules/error-handling.md +336 -336
  59. package/augment-extensions/coding-standards/php/rules/legacy-migration.md +677 -677
  60. package/augment-extensions/coding-standards/php/rules/naming-conventions.md +279 -279
  61. package/augment-extensions/coding-standards/php/rules/performance.md +392 -392
  62. package/augment-extensions/coding-standards/php/rules/psr-standards.md +186 -186
  63. package/augment-extensions/coding-standards/php/rules/security.md +358 -358
  64. package/augment-extensions/coding-standards/php/rules/testing.md +403 -403
  65. package/augment-extensions/coding-standards/php/rules/type-declarations.md +331 -331
  66. package/augment-extensions/coding-standards/php/rules/web-applications.md +426 -426
  67. package/augment-extensions/coding-standards/powershell/README.md +154 -154
  68. package/augment-extensions/coding-standards/powershell/examples/admin-example.ps1 +272 -272
  69. package/augment-extensions/coding-standards/powershell/examples/automation-example.ps1 +173 -173
  70. package/augment-extensions/coding-standards/powershell/examples/cloud-example.ps1 +243 -243
  71. package/augment-extensions/coding-standards/powershell/examples/cross-platform-example.ps1 +297 -297
  72. package/augment-extensions/coding-standards/powershell/examples/dsc-example.ps1 +224 -224
  73. package/augment-extensions/coding-standards/powershell/examples/legacy-migration-example.ps1 +340 -340
  74. package/augment-extensions/coding-standards/powershell/examples/module-example.psm1 +255 -255
  75. package/augment-extensions/coding-standards/powershell/module.json +165 -165
  76. package/augment-extensions/coding-standards/powershell/rules/administrative-tools.md +439 -439
  77. package/augment-extensions/coding-standards/powershell/rules/automation-scripts.md +240 -240
  78. package/augment-extensions/coding-standards/powershell/rules/cloud-orchestration.md +384 -384
  79. package/augment-extensions/coding-standards/powershell/rules/configuration-schema.md +383 -383
  80. package/augment-extensions/coding-standards/powershell/rules/cross-platform-scripts.md +482 -482
  81. package/augment-extensions/coding-standards/powershell/rules/dsc-configurations.md +296 -296
  82. package/augment-extensions/coding-standards/powershell/rules/error-handling.md +314 -314
  83. package/augment-extensions/coding-standards/powershell/rules/legacy-migrations.md +466 -466
  84. package/augment-extensions/coding-standards/powershell/rules/modules-functions.md +244 -244
  85. package/augment-extensions/coding-standards/powershell/rules/naming-conventions.md +266 -266
  86. package/augment-extensions/coding-standards/powershell/rules/performance-optimization.md +209 -209
  87. package/augment-extensions/coding-standards/powershell/rules/security-practices.md +314 -314
  88. package/augment-extensions/coding-standards/powershell/rules/testing-guidelines.md +268 -268
  89. package/augment-extensions/coding-standards/powershell/rules/universal-standards.md +197 -197
  90. package/augment-extensions/coding-standards/python/README.md +48 -48
  91. package/augment-extensions/coding-standards/python/examples/best-practices.py +373 -373
  92. package/augment-extensions/coding-standards/python/module.json +30 -30
  93. package/augment-extensions/coding-standards/python/rules/async-patterns.md +884 -884
  94. package/augment-extensions/coding-standards/python/rules/best-practices.md +232 -232
  95. package/augment-extensions/coding-standards/python/rules/code-organization.md +220 -220
  96. package/augment-extensions/coding-standards/python/rules/documentation.md +831 -831
  97. package/augment-extensions/coding-standards/python/rules/error-handling.md +1008 -1008
  98. package/augment-extensions/coding-standards/python/rules/naming-conventions.md +172 -172
  99. package/augment-extensions/coding-standards/python/rules/testing.md +409 -409
  100. package/augment-extensions/coding-standards/python/rules/tooling.md +446 -446
  101. package/augment-extensions/coding-standards/python/rules/type-hints.md +253 -253
  102. package/augment-extensions/coding-standards/react/README.md +45 -45
  103. package/augment-extensions/coding-standards/react/module.json +27 -27
  104. package/augment-extensions/coding-standards/react/rules/component-patterns.md +214 -214
  105. package/augment-extensions/coding-standards/react/rules/hooks-best-practices.md +235 -235
  106. package/augment-extensions/coding-standards/react/rules/performance.md +300 -300
  107. package/augment-extensions/coding-standards/react/rules/state-management.md +265 -265
  108. package/augment-extensions/coding-standards/react/rules/typescript-react.md +271 -271
  109. package/augment-extensions/coding-standards/typescript/README.md +45 -45
  110. package/augment-extensions/coding-standards/typescript/module.json +27 -27
  111. package/augment-extensions/coding-standards/typescript/rules/naming-conventions.md +225 -225
  112. package/augment-extensions/collections/html-css-js/README.md +82 -82
  113. package/augment-extensions/collections/html-css-js/collection.json +41 -41
  114. package/augment-extensions/domain-rules/api-design/README.md +41 -41
  115. package/augment-extensions/domain-rules/api-design/module.json +27 -27
  116. package/augment-extensions/domain-rules/api-design/rules/authentication.md +263 -263
  117. package/augment-extensions/domain-rules/api-design/rules/documentation.md +395 -395
  118. package/augment-extensions/domain-rules/api-design/rules/error-handling.md +290 -290
  119. package/augment-extensions/domain-rules/api-design/rules/graphql-api.md +313 -313
  120. package/augment-extensions/domain-rules/api-design/rules/rest-api.md +214 -214
  121. package/augment-extensions/domain-rules/api-design/rules/versioning.md +268 -268
  122. package/augment-extensions/domain-rules/database/README.md +161 -161
  123. package/augment-extensions/domain-rules/database/examples/flat-database-example.md +793 -793
  124. package/augment-extensions/domain-rules/database/examples/hybrid-database-example.md +1132 -1132
  125. package/augment-extensions/domain-rules/database/examples/nosql-document-example.md +868 -868
  126. package/augment-extensions/domain-rules/database/examples/nosql-graph-example.md +805 -805
  127. package/augment-extensions/domain-rules/database/examples/relational-schema-example.md +621 -621
  128. package/augment-extensions/domain-rules/database/examples/vector-database-example.md +965 -965
  129. package/augment-extensions/domain-rules/database/module.json +28 -28
  130. package/augment-extensions/domain-rules/database/rules/flat-databases.md +624 -624
  131. package/augment-extensions/domain-rules/database/rules/nosql-databases.md +588 -588
  132. package/augment-extensions/domain-rules/database/rules/nosql-document-stores.md +856 -856
  133. package/augment-extensions/domain-rules/database/rules/nosql-graph-databases.md +778 -778
  134. package/augment-extensions/domain-rules/database/rules/nosql-key-value-stores.md +963 -963
  135. package/augment-extensions/domain-rules/database/rules/performance-optimization.md +1076 -1076
  136. package/augment-extensions/domain-rules/database/rules/relational-databases.md +697 -697
  137. package/augment-extensions/domain-rules/database/rules/relational-indexing.md +671 -671
  138. package/augment-extensions/domain-rules/database/rules/relational-query-optimization.md +607 -607
  139. package/augment-extensions/domain-rules/database/rules/relational-schema-design.md +907 -907
  140. package/augment-extensions/domain-rules/database/rules/relational-transactions.md +783 -783
  141. package/augment-extensions/domain-rules/database/rules/security-standards.md +980 -980
  142. package/augment-extensions/domain-rules/database/rules/universal-best-practices.md +485 -485
  143. package/augment-extensions/domain-rules/database/rules/vector-databases.md +521 -521
  144. package/augment-extensions/domain-rules/database/rules/vector-embeddings.md +858 -858
  145. package/augment-extensions/domain-rules/database/rules/vector-indexing.md +934 -934
  146. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/README.md +23 -23
  147. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/module.json +26 -26
  148. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/README.md +23 -23
  149. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/module.json +26 -26
  150. package/augment-extensions/domain-rules/design/color/themes/dracula/README.md +23 -23
  151. package/augment-extensions/domain-rules/design/color/themes/dracula/module.json +26 -26
  152. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/README.md +23 -23
  153. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/module.json +26 -26
  154. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/README.md +23 -23
  155. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/module.json +26 -26
  156. package/augment-extensions/domain-rules/design/color/themes/high-contrast/README.md +27 -27
  157. package/augment-extensions/domain-rules/design/color/themes/high-contrast/module.json +26 -26
  158. package/augment-extensions/domain-rules/design/color/themes/monokai/README.md +23 -23
  159. package/augment-extensions/domain-rules/design/color/themes/monokai/module.json +26 -26
  160. package/augment-extensions/domain-rules/design/color/themes/nord/README.md +23 -23
  161. package/augment-extensions/domain-rules/design/color/themes/nord/module.json +26 -26
  162. package/augment-extensions/domain-rules/design/color/themes/one-dark/README.md +23 -23
  163. package/augment-extensions/domain-rules/design/color/themes/one-dark/module.json +26 -26
  164. package/augment-extensions/domain-rules/design/color/themes/one-light/README.md +23 -23
  165. package/augment-extensions/domain-rules/design/color/themes/one-light/module.json +26 -26
  166. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/README.md +23 -23
  167. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/module.json +26 -26
  168. package/augment-extensions/domain-rules/design/color/themes/solarized-light/README.md +23 -23
  169. package/augment-extensions/domain-rules/design/color/themes/solarized-light/module.json +26 -26
  170. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/README.md +23 -23
  171. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/module.json +26 -26
  172. package/augment-extensions/domain-rules/mcp/README.md +150 -150
  173. package/augment-extensions/domain-rules/mcp/examples/compressed-example.md +522 -522
  174. package/augment-extensions/domain-rules/mcp/examples/graph-augmented-example.md +520 -520
  175. package/augment-extensions/domain-rules/mcp/examples/hybrid-example.md +570 -570
  176. package/augment-extensions/domain-rules/mcp/examples/state-based-example.md +427 -427
  177. package/augment-extensions/domain-rules/mcp/examples/token-based-example.md +435 -435
  178. package/augment-extensions/domain-rules/mcp/examples/vector-based-example.md +502 -502
  179. package/augment-extensions/domain-rules/mcp/module.json +49 -49
  180. package/augment-extensions/domain-rules/mcp/rules/compressed-mcp.md +595 -595
  181. package/augment-extensions/domain-rules/mcp/rules/configuration.md +345 -345
  182. package/augment-extensions/domain-rules/mcp/rules/graph-augmented-mcp.md +687 -687
  183. package/augment-extensions/domain-rules/mcp/rules/hybrid-mcp.md +636 -636
  184. package/augment-extensions/domain-rules/mcp/rules/state-based-mcp.md +484 -484
  185. package/augment-extensions/domain-rules/mcp/rules/testing-validation.md +360 -360
  186. package/augment-extensions/domain-rules/mcp/rules/token-based-mcp.md +393 -393
  187. package/augment-extensions/domain-rules/mcp/rules/universal-rules.md +194 -194
  188. package/augment-extensions/domain-rules/mcp/rules/vector-based-mcp.md +625 -625
  189. package/augment-extensions/domain-rules/security/README.md +41 -41
  190. package/augment-extensions/domain-rules/security/module.json +28 -28
  191. package/augment-extensions/domain-rules/security/rules/authentication-security.md +361 -361
  192. package/augment-extensions/domain-rules/security/rules/encryption.md +208 -208
  193. package/augment-extensions/domain-rules/security/rules/input-validation.md +294 -294
  194. package/augment-extensions/domain-rules/security/rules/owasp-top-10.md +339 -339
  195. package/augment-extensions/domain-rules/security/rules/secure-coding.md +293 -293
  196. package/augment-extensions/domain-rules/security/rules/web-security.md +268 -268
  197. package/augment-extensions/domain-rules/seo-sales-marketing/ANNOUNCEMENT.md +143 -0
  198. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/README.md +140 -136
  199. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/SCHEMA-VALIDATION-REPORT.md +216 -216
  200. package/augment-extensions/domain-rules/seo-sales-marketing/TEST-VALIDATION.md +129 -0
  201. package/augment-extensions/domain-rules/seo-sales-marketing/USAGE-GUIDES.md +254 -0
  202. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/brand-kit-example.yaml +292 -292
  203. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/campaign-brief-example.yaml +389 -389
  204. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/content-calendar-example.yaml +643 -643
  205. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/email-newsletter-example.md +376 -376
  206. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/landing-page-example.md +934 -934
  207. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/ppc-ad-copy-example.md +301 -301
  208. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/seo-blog-post-example.md +347 -347
  209. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/social-media-campaign-example.md +606 -606
  210. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/module.json +50 -50
  211. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/affiliate-influencer-marketing.md +593 -593
  212. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/asset-management.md +418 -418
  213. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/brand-consistency.md +210 -210
  214. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/content-marketing.md +337 -337
  215. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/conversion-optimization.md +455 -455
  216. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/direct-sales.md +499 -499
  217. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/email-marketing.md +439 -439
  218. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/legal-compliance.md +227 -227
  219. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/ppc-advertising.md +569 -569
  220. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/seo-optimization.md +470 -470
  221. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/social-media-marketing.md +414 -414
  222. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/universal-marketing.md +177 -177
  223. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/asset-inventory.schema.json +247 -247
  224. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/brand-kit.schema.json +326 -326
  225. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/campaign-brief.schema.json +342 -342
  226. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/color-palette.schema.json +223 -223
  227. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/content-template.schema.json +383 -383
  228. package/augment-extensions/domain-rules/wordpress/README.md +163 -163
  229. package/augment-extensions/domain-rules/wordpress/module.json +32 -32
  230. package/augment-extensions/domain-rules/wordpress/rules/coding-standards.md +617 -617
  231. package/augment-extensions/domain-rules/wordpress/rules/directory-structure.md +270 -270
  232. package/augment-extensions/domain-rules/wordpress/rules/file-patterns.md +423 -423
  233. package/augment-extensions/domain-rules/wordpress/rules/gutenberg-blocks.md +493 -493
  234. package/augment-extensions/domain-rules/wordpress/rules/performance.md +568 -568
  235. package/augment-extensions/domain-rules/wordpress/rules/plugin-development.md +510 -510
  236. package/augment-extensions/domain-rules/wordpress/rules/project-detection.md +251 -251
  237. package/augment-extensions/domain-rules/wordpress/rules/rest-api.md +501 -501
  238. package/augment-extensions/domain-rules/wordpress/rules/security.md +564 -564
  239. package/augment-extensions/domain-rules/wordpress/rules/theme-development.md +388 -388
  240. package/augment-extensions/domain-rules/wordpress/rules/woocommerce.md +441 -441
  241. package/augment-extensions/domain-rules/wordpress-plugin/README.md +139 -139
  242. package/augment-extensions/domain-rules/wordpress-plugin/examples/ajax-plugin.md +1599 -1599
  243. package/augment-extensions/domain-rules/wordpress-plugin/examples/custom-post-type-plugin.md +1727 -1727
  244. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block-plugin.md +428 -428
  245. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block.md +422 -422
  246. package/augment-extensions/domain-rules/wordpress-plugin/examples/mvc-plugin.md +1623 -1623
  247. package/augment-extensions/domain-rules/wordpress-plugin/examples/object-oriented-plugin.md +1343 -1343
  248. package/augment-extensions/domain-rules/wordpress-plugin/examples/rest-endpoint.md +734 -734
  249. package/augment-extensions/domain-rules/wordpress-plugin/examples/settings-page-plugin.md +1350 -1350
  250. package/augment-extensions/domain-rules/wordpress-plugin/examples/simple-procedural-plugin.md +503 -503
  251. package/augment-extensions/domain-rules/wordpress-plugin/examples/singleton-plugin.md +971 -971
  252. package/augment-extensions/domain-rules/wordpress-plugin/module.json +53 -53
  253. package/augment-extensions/domain-rules/wordpress-plugin/rules/activation-hooks.md +770 -770
  254. package/augment-extensions/domain-rules/wordpress-plugin/rules/admin-interface.md +874 -874
  255. package/augment-extensions/domain-rules/wordpress-plugin/rules/ajax-handlers.md +629 -629
  256. package/augment-extensions/domain-rules/wordpress-plugin/rules/asset-management.md +559 -559
  257. package/augment-extensions/domain-rules/wordpress-plugin/rules/context-providers.md +709 -709
  258. package/augment-extensions/domain-rules/wordpress-plugin/rules/cron-jobs.md +736 -736
  259. package/augment-extensions/domain-rules/wordpress-plugin/rules/database-management.md +1057 -1057
  260. package/augment-extensions/domain-rules/wordpress-plugin/rules/documentation-standards.md +463 -463
  261. package/augment-extensions/domain-rules/wordpress-plugin/rules/frontend-functionality.md +478 -478
  262. package/augment-extensions/domain-rules/wordpress-plugin/rules/gutenberg-blocks.md +818 -818
  263. package/augment-extensions/domain-rules/wordpress-plugin/rules/internationalization.md +416 -416
  264. package/augment-extensions/domain-rules/wordpress-plugin/rules/migration.md +667 -667
  265. package/augment-extensions/domain-rules/wordpress-plugin/rules/performance-optimization.md +878 -878
  266. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-architecture.md +693 -693
  267. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-structure.md +352 -352
  268. package/augment-extensions/domain-rules/wordpress-plugin/rules/rest-api.md +818 -818
  269. package/augment-extensions/domain-rules/wordpress-plugin/rules/scaffolding-workflow.md +624 -624
  270. package/augment-extensions/domain-rules/wordpress-plugin/rules/security-best-practices.md +866 -866
  271. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing-patterns.md +1165 -1165
  272. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing.md +414 -414
  273. package/augment-extensions/domain-rules/wordpress-plugin/rules/vscode-integration.md +751 -751
  274. package/augment-extensions/domain-rules/wordpress-plugin/rules/woocommerce-integration.md +949 -949
  275. package/augment-extensions/domain-rules/wordpress-plugin/rules/wordpress-org-submission.md +458 -458
  276. package/augment-extensions/examples/design-patterns/README.md +37 -37
  277. package/augment-extensions/examples/design-patterns/examples/behavioral-patterns.md +370 -370
  278. package/augment-extensions/examples/design-patterns/examples/creational-patterns.md +250 -250
  279. package/augment-extensions/examples/design-patterns/examples/structural-patterns.md +264 -264
  280. package/augment-extensions/examples/design-patterns/module.json +27 -27
  281. package/augment-extensions/examples/gutenberg-block-plugin/README.md +101 -101
  282. package/augment-extensions/examples/gutenberg-block-plugin/examples/testimonial-block.md +428 -428
  283. package/augment-extensions/examples/gutenberg-block-plugin/module.json +40 -40
  284. package/augment-extensions/examples/rest-api-plugin/README.md +98 -98
  285. package/augment-extensions/examples/rest-api-plugin/examples/task-manager-api.md +1299 -1299
  286. package/augment-extensions/examples/rest-api-plugin/module.json +40 -40
  287. package/augment-extensions/examples/woocommerce-extension/README.md +98 -98
  288. package/augment-extensions/examples/woocommerce-extension/examples/product-customizer.md +763 -763
  289. package/augment-extensions/examples/woocommerce-extension/module.json +40 -40
  290. package/augment-extensions/workflows/beads/README.md +135 -135
  291. package/augment-extensions/workflows/beads/examples/complete-workflow-example.md +278 -278
  292. package/augment-extensions/workflows/beads/module.json +55 -55
  293. package/augment-extensions/workflows/beads/rules/best-practices.md +398 -398
  294. package/augment-extensions/workflows/beads/rules/file-format.md +327 -327
  295. package/augment-extensions/workflows/beads/rules/manual-setup.md +315 -315
  296. package/augment-extensions/workflows/beads/rules/workflow.md +326 -326
  297. package/augment-extensions/workflows/beads-integration/IMPLEMENTATION-STATUS.md +145 -145
  298. package/augment-extensions/workflows/beads-integration/README.md +143 -143
  299. package/augment-extensions/workflows/beads-integration/config/defaults.json +32 -32
  300. package/augment-extensions/workflows/beads-integration/config/schema.json +140 -140
  301. package/augment-extensions/workflows/beads-integration/examples/basic-task-generation.md +293 -293
  302. package/augment-extensions/workflows/beads-integration/module.json +75 -75
  303. package/augment-extensions/workflows/beads-integration/rules/core-rules.md +219 -219
  304. package/augment-extensions/workflows/beads-integration/rules/effectiveness-standards.md +256 -256
  305. package/augment-extensions/workflows/beads-integration/rules/task-generation.md +607 -607
  306. package/augment-extensions/workflows/database/README.md +195 -195
  307. package/augment-extensions/workflows/database/ai-prompt-testing.md +295 -295
  308. package/augment-extensions/workflows/database/examples/migration-example.md +498 -498
  309. package/augment-extensions/workflows/database/examples/optimization-example.md +496 -496
  310. package/augment-extensions/workflows/database/examples/schema-design-example.md +444 -444
  311. package/augment-extensions/workflows/database/module.json +42 -42
  312. package/augment-extensions/workflows/database/rules/data-migration.md +249 -249
  313. package/augment-extensions/workflows/database/rules/documentation-standards.md +339 -339
  314. package/augment-extensions/workflows/database/rules/migration-workflow.md +352 -352
  315. package/augment-extensions/workflows/database/rules/optimization-workflow.md +435 -435
  316. package/augment-extensions/workflows/database/rules/schema-design-workflow.md +535 -535
  317. package/augment-extensions/workflows/database/rules/testing-patterns.md +305 -305
  318. package/augment-extensions/workflows/database/rules/workflow.md +458 -458
  319. package/augment-extensions/workflows/wordpress-plugin/README.md +232 -232
  320. package/augment-extensions/workflows/wordpress-plugin/ai-prompts.md +839 -839
  321. package/augment-extensions/workflows/wordpress-plugin/bead-decomposition-patterns.md +854 -854
  322. package/augment-extensions/workflows/wordpress-plugin/examples/complete-plugin-example.md +540 -540
  323. package/augment-extensions/workflows/wordpress-plugin/examples/custom-post-type-example.md +1083 -1083
  324. package/augment-extensions/workflows/wordpress-plugin/examples/feature-addition-workflow.md +669 -669
  325. package/augment-extensions/workflows/wordpress-plugin/examples/plugin-creation-workflow.md +597 -597
  326. package/augment-extensions/workflows/wordpress-plugin/examples/secure-form-handler-example.md +925 -925
  327. package/augment-extensions/workflows/wordpress-plugin/examples/security-audit-workflow.md +752 -752
  328. package/augment-extensions/workflows/wordpress-plugin/examples/wordpress-org-submission-workflow.md +773 -773
  329. package/augment-extensions/workflows/wordpress-plugin/module.json +49 -49
  330. package/augment-extensions/workflows/wordpress-plugin/rules/best-practices.md +942 -942
  331. package/augment-extensions/workflows/wordpress-plugin/rules/development-workflow.md +702 -702
  332. package/augment-extensions/workflows/wordpress-plugin/rules/submission-workflow.md +728 -728
  333. package/augment-extensions/workflows/wordpress-plugin/rules/testing-workflow.md +775 -775
  334. package/augment-extensions/writing-standards/screenplay/README.md +339 -300
  335. package/augment-extensions/writing-standards/screenplay/_templates/README.md +121 -121
  336. package/augment-extensions/writing-standards/screenplay/_templates/genre-template.md +153 -153
  337. package/augment-extensions/writing-standards/screenplay/_templates/style-template.md +243 -243
  338. package/augment-extensions/writing-standards/screenplay/_templates/theme-template.md +213 -213
  339. package/augment-extensions/writing-standards/screenplay/examples/aaa-hollywood-scene.fountain +164 -164
  340. package/augment-extensions/writing-standards/screenplay/examples/beat-sheet-example.yaml +95 -95
  341. package/augment-extensions/writing-standards/screenplay/examples/character-profile-example.yaml +116 -116
  342. package/augment-extensions/writing-standards/screenplay/examples/commercial-30sec.fountain +151 -151
  343. package/augment-extensions/writing-standards/screenplay/examples/independent-monologue.fountain +67 -67
  344. package/augment-extensions/writing-standards/screenplay/examples/news-segment.fountain +142 -142
  345. package/augment-extensions/writing-standards/screenplay/examples/plot-outline-example.yaml +184 -184
  346. package/augment-extensions/writing-standards/screenplay/examples/tv-episode-teaser.fountain +204 -204
  347. package/augment-extensions/writing-standards/screenplay/genres/README.md +181 -181
  348. package/augment-extensions/writing-standards/screenplay/genres/examples/.gitkeep +2 -2
  349. package/augment-extensions/writing-standards/screenplay/genres/module.json +70 -70
  350. package/augment-extensions/writing-standards/screenplay/genres/rules/.gitkeep +2 -2
  351. package/augment-extensions/writing-standards/screenplay/genres/rules/action.md +399 -399
  352. package/augment-extensions/writing-standards/screenplay/genres/rules/adventure.md +407 -407
  353. package/augment-extensions/writing-standards/screenplay/genres/rules/animation.md +293 -293
  354. package/augment-extensions/writing-standards/screenplay/genres/rules/biographical.md +293 -293
  355. package/augment-extensions/writing-standards/screenplay/genres/rules/comedy.md +401 -401
  356. package/augment-extensions/writing-standards/screenplay/genres/rules/documentary.md +293 -293
  357. package/augment-extensions/writing-standards/screenplay/genres/rules/drama.md +409 -409
  358. package/augment-extensions/writing-standards/screenplay/genres/rules/fantasy.md +293 -293
  359. package/augment-extensions/writing-standards/screenplay/genres/rules/historical.md +293 -293
  360. package/augment-extensions/writing-standards/screenplay/genres/rules/horror.md +268 -268
  361. package/augment-extensions/writing-standards/screenplay/genres/rules/musical.md +294 -294
  362. package/augment-extensions/writing-standards/screenplay/genres/rules/mystery.md +293 -293
  363. package/augment-extensions/writing-standards/screenplay/genres/rules/noir.md +294 -294
  364. package/augment-extensions/writing-standards/screenplay/genres/rules/romance.md +293 -293
  365. package/augment-extensions/writing-standards/screenplay/genres/rules/sci-fi.md +289 -289
  366. package/augment-extensions/writing-standards/screenplay/genres/rules/superhero.md +293 -293
  367. package/augment-extensions/writing-standards/screenplay/genres/rules/thriller.md +294 -294
  368. package/augment-extensions/writing-standards/screenplay/genres/rules/western.md +293 -293
  369. package/augment-extensions/writing-standards/screenplay/module.json +124 -124
  370. package/augment-extensions/writing-standards/screenplay/rules/aaa-hollywood-films.md +339 -339
  371. package/augment-extensions/writing-standards/screenplay/rules/ai-integration-testing.md +329 -329
  372. package/augment-extensions/writing-standards/screenplay/rules/character-development.md +169 -169
  373. package/augment-extensions/writing-standards/screenplay/rules/commercials.md +437 -437
  374. package/augment-extensions/writing-standards/screenplay/rules/dialogue-writing.md +263 -263
  375. package/augment-extensions/writing-standards/screenplay/rules/diversity-inclusion.md +261 -261
  376. package/augment-extensions/writing-standards/screenplay/rules/examples-guide.md +315 -315
  377. package/augment-extensions/writing-standards/screenplay/rules/file-organization.md +213 -0
  378. package/augment-extensions/writing-standards/screenplay/rules/formatting-validation.md +413 -413
  379. package/augment-extensions/writing-standards/screenplay/rules/fountain-format.md +372 -372
  380. package/augment-extensions/writing-standards/screenplay/rules/independent-films.md +374 -374
  381. package/augment-extensions/writing-standards/screenplay/rules/live-tv-productions.md +443 -443
  382. package/augment-extensions/writing-standards/screenplay/rules/narrative-structures.md +207 -207
  383. package/augment-extensions/writing-standards/screenplay/rules/news-broadcasts.md +444 -444
  384. package/augment-extensions/writing-standards/screenplay/rules/pacing-timing.md +331 -331
  385. package/augment-extensions/writing-standards/screenplay/rules/quality-review-checklist.md +334 -334
  386. package/augment-extensions/writing-standards/screenplay/rules/quick-reference.md +299 -299
  387. package/augment-extensions/writing-standards/screenplay/rules/screen-continuity.md +263 -263
  388. package/augment-extensions/writing-standards/screenplay/rules/streaming-content.md +412 -412
  389. package/augment-extensions/writing-standards/screenplay/rules/trope-management.md +370 -370
  390. package/augment-extensions/writing-standards/screenplay/rules/tv-series.md +374 -374
  391. package/augment-extensions/writing-standards/screenplay/rules/universal-formatting.md +339 -339
  392. package/augment-extensions/writing-standards/screenplay/rules/vscode-integration.md +277 -277
  393. package/augment-extensions/writing-standards/screenplay/rules/web-content.md +393 -393
  394. package/augment-extensions/writing-standards/screenplay/schemas/beat-sheet.json +332 -332
  395. package/augment-extensions/writing-standards/screenplay/schemas/character-profile.json +247 -247
  396. package/augment-extensions/writing-standards/screenplay/schemas/feature-selection.json +200 -200
  397. package/augment-extensions/writing-standards/screenplay/schemas/plot-outline.json +233 -233
  398. package/augment-extensions/writing-standards/screenplay/schemas/screenplay-config.json +245 -245
  399. package/augment-extensions/writing-standards/screenplay/schemas/trope-inventory.json +221 -221
  400. package/augment-extensions/writing-standards/screenplay/styles/README.md +159 -159
  401. package/augment-extensions/writing-standards/screenplay/styles/examples/.gitkeep +2 -2
  402. package/augment-extensions/writing-standards/screenplay/styles/examples/style-applications.md +1449 -1449
  403. package/augment-extensions/writing-standards/screenplay/styles/module.json +64 -64
  404. package/augment-extensions/writing-standards/screenplay/styles/rules/.gitkeep +2 -2
  405. package/augment-extensions/writing-standards/screenplay/styles/rules/dialogue-centric.md +520 -520
  406. package/augment-extensions/writing-standards/screenplay/styles/rules/ensemble.md +499 -499
  407. package/augment-extensions/writing-standards/screenplay/styles/rules/epic.md +497 -497
  408. package/augment-extensions/writing-standards/screenplay/styles/rules/experimental.md +492 -492
  409. package/augment-extensions/writing-standards/screenplay/styles/rules/flashback.md +509 -509
  410. package/augment-extensions/writing-standards/screenplay/styles/rules/linear.md +490 -490
  411. package/augment-extensions/writing-standards/screenplay/styles/rules/minimalist.md +499 -499
  412. package/augment-extensions/writing-standards/screenplay/styles/rules/non-linear.md +501 -501
  413. package/augment-extensions/writing-standards/screenplay/styles/rules/poetic.md +499 -499
  414. package/augment-extensions/writing-standards/screenplay/styles/rules/realistic.md +498 -498
  415. package/augment-extensions/writing-standards/screenplay/styles/rules/satirical.md +499 -499
  416. package/augment-extensions/writing-standards/screenplay/styles/rules/surreal.md +508 -508
  417. package/augment-extensions/writing-standards/screenplay/styles/rules/voice-over.md +500 -500
  418. package/augment-extensions/writing-standards/screenplay/themes/README.md +158 -158
  419. package/augment-extensions/writing-standards/screenplay/themes/examples/.gitkeep +2 -2
  420. package/augment-extensions/writing-standards/screenplay/themes/examples/common-mistakes-and-fixes.md +643 -643
  421. package/augment-extensions/writing-standards/screenplay/themes/examples/complete-scene-example.md +311 -311
  422. package/augment-extensions/writing-standards/screenplay/themes/examples/individual-theme-examples.md +562 -562
  423. package/augment-extensions/writing-standards/screenplay/themes/examples/multi-theme-weaving.md +538 -538
  424. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-application-guide.md +432 -432
  425. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-integration-across-acts.md +637 -637
  426. package/augment-extensions/writing-standards/screenplay/themes/module.json +66 -66
  427. package/augment-extensions/writing-standards/screenplay/themes/rules/.gitkeep +2 -2
  428. package/augment-extensions/writing-standards/screenplay/themes/rules/ambition.md +458 -458
  429. package/augment-extensions/writing-standards/screenplay/themes/rules/betrayal.md +490 -490
  430. package/augment-extensions/writing-standards/screenplay/themes/rules/environment.md +458 -458
  431. package/augment-extensions/writing-standards/screenplay/themes/rules/fate.md +459 -459
  432. package/augment-extensions/writing-standards/screenplay/themes/rules/friendship.md +491 -491
  433. package/augment-extensions/writing-standards/screenplay/themes/rules/growth.md +491 -491
  434. package/augment-extensions/writing-standards/screenplay/themes/rules/identity.md +490 -490
  435. package/augment-extensions/writing-standards/screenplay/themes/rules/isolation.md +464 -464
  436. package/augment-extensions/writing-standards/screenplay/themes/rules/justice.md +461 -461
  437. package/augment-extensions/writing-standards/screenplay/themes/rules/love.md +489 -489
  438. package/augment-extensions/writing-standards/screenplay/themes/rules/power.md +494 -494
  439. package/augment-extensions/writing-standards/screenplay/themes/rules/redemption.md +483 -483
  440. package/augment-extensions/writing-standards/screenplay/themes/rules/revenge.md +489 -489
  441. package/augment-extensions/writing-standards/screenplay/themes/rules/survival.md +496 -496
  442. package/augment-extensions/writing-standards/screenplay/themes/rules/technology.md +463 -463
  443. package/augment-extensions/writing-standards/screenplay/utils/__tests__/file-organization.test.ts +169 -0
  444. package/augment-extensions/writing-standards/screenplay/utils/file-organization.ts +165 -0
  445. package/cli/MODULES.md +302 -302
  446. package/cli/dist/cli.js +109 -22
  447. package/cli/dist/cli.js.map +1 -1
  448. package/cli/dist/commands/gui.d.ts.map +1 -1
  449. package/cli/dist/commands/gui.js +54 -6
  450. package/cli/dist/commands/gui.js.map +1 -1
  451. package/cli/dist/commands/init.d.ts.map +1 -1
  452. package/cli/dist/commands/init.js +76 -23
  453. package/cli/dist/commands/init.js.map +1 -1
  454. package/cli/dist/commands/self-remove.d.ts.map +1 -1
  455. package/cli/dist/commands/self-remove.js +48 -74
  456. package/cli/dist/commands/self-remove.js.map +1 -1
  457. package/cli/dist/commands/show.d.ts +11 -0
  458. package/cli/dist/commands/show.d.ts.map +1 -1
  459. package/cli/dist/commands/show.js +120 -0
  460. package/cli/dist/commands/show.js.map +1 -1
  461. package/cli/dist/commands/showCompleted.d.ts +21 -0
  462. package/cli/dist/commands/showCompleted.d.ts.map +1 -0
  463. package/cli/dist/commands/showCompleted.js +225 -0
  464. package/cli/dist/commands/showCompleted.js.map +1 -0
  465. package/cli/dist/commands/skill.js +88 -88
  466. package/cli/dist/commands/update.d.ts +2 -0
  467. package/cli/dist/commands/update.d.ts.map +1 -1
  468. package/cli/dist/commands/update.js +67 -1
  469. package/cli/dist/commands/update.js.map +1 -1
  470. package/cli/dist/utils/beadsCompletedChecker.d.ts +72 -0
  471. package/cli/dist/utils/beadsCompletedChecker.d.ts.map +1 -0
  472. package/cli/dist/utils/beadsCompletedChecker.js +198 -0
  473. package/cli/dist/utils/beadsCompletedChecker.js.map +1 -0
  474. package/cli/dist/utils/catalog-sync.js +13 -13
  475. package/cli/dist/utils/extractCommandHelp.d.ts +51 -0
  476. package/cli/dist/utils/extractCommandHelp.d.ts.map +1 -0
  477. package/cli/dist/utils/extractCommandHelp.js +250 -0
  478. package/cli/dist/utils/extractCommandHelp.js.map +1 -0
  479. package/cli/dist/utils/install-rules.js +55 -55
  480. package/cli/dist/utils/mcp-integration.js +44 -44
  481. package/cli/dist/utils/rule-install-hooks.js +8 -8
  482. package/modules.md +667 -630
  483. package/package.json +85 -85
@@ -1,868 +1,868 @@
1
- # NoSQL Document Store Example: Blog Application
2
-
3
- ## Overview
4
-
5
- This example demonstrates a complete blog application using MongoDB as a document store. It covers schema design decisions (embedding vs referencing), aggregation pipelines, indexing strategies, and common query patterns.
6
-
7
- ---
8
-
9
- ## Application Requirements
10
-
11
- **Features:**
12
- - Users can create accounts
13
- - Users can write blog posts
14
- - Users can comment on posts
15
- - Users can like posts and comments
16
- - Posts can have tags
17
- - Users can follow other users
18
-
19
- **Query Patterns:**
20
- - Find all posts by a user
21
- - Find recent posts with author info
22
- - Find posts by tag
23
- - Find comments for a post
24
- - Find user's feed (posts from followed users)
25
- - Count likes on posts
26
- - Find popular posts (most likes/comments)
27
-
28
- ---
29
-
30
- ## Schema Design
31
-
32
- ### Collections
33
-
34
- **users** - User accounts
35
- **posts** - Blog posts
36
- **comments** - Comments on posts
37
- **tags** - Post tags
38
-
39
- ### Design Decisions
40
-
41
- #### Decision 1: User Profile (Embedding)
42
-
43
- **Embed profile data in user document:**
44
-
45
- ```javascript
46
- // ✅ GOOD: Embed profile (one-to-one, always accessed together)
47
- {
48
- "_id": ObjectId("507f1f77bcf86cd799439011"),
49
- "username": "alice_dev",
50
- "email": "alice@example.com",
51
- "password_hash": "$2b$10$...",
52
- "profile": {
53
- "full_name": "Alice Johnson",
54
- "bio": "Full-stack developer passionate about web technologies",
55
- "avatar_url": "https://cdn.example.com/avatars/alice.jpg",
56
- "location": "San Francisco, CA",
57
- "website": "https://alice.dev"
58
- },
59
- "stats": {
60
- "post_count": 42,
61
- "follower_count": 156,
62
- "following_count": 89
63
- },
64
- "created_at": ISODate("2024-01-15T10:00:00Z"),
65
- "updated_at": ISODate("2024-01-20T14:30:00Z")
66
- }
67
- ```
68
-
69
- **Why embed?**
70
- - ✅ Profile is always accessed with user data
71
- - ✅ One-to-one relationship
72
- - ✅ Profile data doesn't change frequently
73
- - ✅ Single query to get complete user info
74
-
75
- #### Decision 2: Blog Posts (Separate Collection)
76
-
77
- **Store posts in separate collection with user reference:**
78
-
79
- ```javascript
80
- // ✅ GOOD: Separate collection (one-to-many, accessed independently)
81
- {
82
- "_id": ObjectId("507f191e810c19729de860ea"),
83
- "author_id": ObjectId("507f1f77bcf86cd799439011"),
84
- "title": "Getting Started with MongoDB",
85
- "slug": "getting-started-with-mongodb",
86
- "content": "MongoDB is a document database that provides...",
87
- "excerpt": "Learn the basics of MongoDB document modeling...",
88
- "status": "published", // draft, published, archived
89
- "tags": ["mongodb", "database", "nosql"], // Embedded array (one-to-few)
90
- "metadata": {
91
- "read_time_minutes": 5,
92
- "word_count": 1200,
93
- "featured_image": "https://cdn.example.com/images/mongodb-intro.jpg"
94
- },
95
- "stats": {
96
- "view_count": 1523,
97
- "like_count": 87,
98
- "comment_count": 12
99
- },
100
- "published_at": ISODate("2024-01-18T09:00:00Z"),
101
- "created_at": ISODate("2024-01-15T14:00:00Z"),
102
- "updated_at": ISODate("2024-01-18T09:00:00Z")
103
- }
104
- ```
105
-
106
- **Why separate collection?**
107
- - ✅ One-to-many relationship (user has many posts)
108
- - ✅ Posts are accessed independently
109
- - ✅ Posts can be queried without user data
110
- - ✅ Avoids unbounded array growth in user document
111
-
112
- **Why embed tags?**
113
- - ✅ One-to-few relationship (< 20 tags per post)
114
- - ✅ Tags are always displayed with post
115
- - ✅ Simple array, no complex queries needed
116
-
117
- #### Decision 3: Comments (Separate Collection with Hybrid Approach)
118
-
119
- **Store comments separately but embed author display info:**
120
-
121
- ```javascript
122
- // ✅ GOOD: Hybrid approach (reference + embedded display data)
123
- {
124
- "_id": ObjectId("507f191e810c19729de860eb"),
125
- "post_id": ObjectId("507f191e810c19729de860ea"),
126
- "author_id": ObjectId("507f1f77bcf86cd799439011"),
127
- "author_display": { // Embedded for fast display
128
- "username": "alice_dev",
129
- "avatar_url": "https://cdn.example.com/avatars/alice.jpg"
130
- },
131
- "content": "Great article! Very helpful for beginners.",
132
- "parent_comment_id": null, // For nested replies
133
- "stats": {
134
- "like_count": 5
135
- },
136
- "created_at": ISODate("2024-01-18T10:30:00Z"),
137
- "updated_at": ISODate("2024-01-18T10:30:00Z")
138
- }
139
- ```
140
-
141
- **Why separate collection?**
142
- - ✅ One-to-many relationship (post has many comments)
143
- - ✅ Unbounded growth (posts can have hundreds of comments)
144
- - ✅ Comments can be paginated
145
- - ✅ Avoids 16MB document size limit
146
-
147
- **Why embed author display data?**
148
- - ✅ Fast display without JOIN
149
- - ✅ Display data rarely changes
150
- - ✅ Small data footprint
151
- - ✅ Can update if needed (eventual consistency acceptable)
152
-
153
- #### Decision 4: Likes (Embedded Array with Limit)
154
-
155
- **Embed recent likes, reference for full list:**
156
-
157
- ```javascript
158
- // In posts collection
159
- {
160
- "_id": ObjectId("507f191e810c19729de860ea"),
161
- "title": "Getting Started with MongoDB",
162
- // ... other fields ...
163
- "stats": {
164
- "like_count": 87 // Total count
165
- },
166
- "recent_likes": [ // Last 10 likes for quick display
167
- {
168
- "user_id": ObjectId("507f1f77bcf86cd799439012"),
169
- "username": "bob_smith",
170
- "liked_at": ISODate("2024-01-20T15:00:00Z")
171
- },
172
- // ... up to 10 recent likes
173
- ]
174
- }
175
-
176
- // Separate likes collection for full history
177
- {
178
- "_id": ObjectId("507f191e810c19729de860ec"),
179
- "post_id": ObjectId("507f191e810c19729de860ea"),
180
- "user_id": ObjectId("507f1f77bcf86cd799439012"),
181
- "created_at": ISODate("2024-01-20T15:00:00Z")
182
- }
183
- ```
184
-
185
- **Why hybrid approach?**
186
- - ✅ Fast display of recent likes (embedded)
187
- - ✅ Full history available (separate collection)
188
- - ✅ Bounded array size (max 10 items)
189
- - ✅ Efficient counting (stats.like_count)
190
-
191
- ---
192
-
193
- ## Indexing Strategy
194
-
195
- ### users Collection
196
-
197
- ```javascript
198
- // Unique index on email (for login)
199
- db.users.createIndex({ "email": 1 }, { unique: true })
200
-
201
- // Unique index on username (for profile URLs)
202
- db.users.createIndex({ "username": 1 }, { unique: true })
203
-
204
- // Index on created_at (for sorting new users)
205
- db.users.createIndex({ "created_at": -1 })
206
- ```
207
-
208
- ### posts Collection
209
-
210
- ```javascript
211
- // Compound index for user's posts (sorted by date)
212
- db.posts.createIndex({ "author_id": 1, "published_at": -1 })
213
-
214
- // Index on slug (for URL lookups)
215
- db.posts.createIndex({ "slug": 1 }, { unique: true })
216
-
217
- // Index on tags (for tag-based queries)
218
- db.posts.createIndex({ "tags": 1 })
219
-
220
- // Index on status and published_at (for published posts feed)
221
- db.posts.createIndex({ "status": 1, "published_at": -1 })
222
-
223
- // Text index for full-text search
224
- db.posts.createIndex({
225
- "title": "text",
226
- "content": "text",
227
- "excerpt": "text"
228
- })
229
- ```
230
-
231
- ### comments Collection
232
-
233
- ```javascript
234
- // Compound index for post's comments (sorted by date)
235
- db.comments.createIndex({ "post_id": 1, "created_at": 1 })
236
-
237
- // Index on author_id (for user's comments)
238
- db.comments.createIndex({ "author_id": 1, "created_at": -1 })
239
-
240
- // Index on parent_comment_id (for nested replies)
241
- db.comments.createIndex({ "parent_comment_id": 1 })
242
- ```
243
-
244
- ### likes Collection
245
-
246
- ```javascript
247
- // Compound unique index (prevent duplicate likes)
248
- db.likes.createIndex({ "post_id": 1, "user_id": 1 }, { unique: true })
249
-
250
- // Index on user_id (for user's liked posts)
251
- db.likes.createIndex({ "user_id": 1, "created_at": -1 })
252
- ```
253
-
254
- ---
255
-
256
- ## Common Queries
257
-
258
- ### Query 1: Find All Posts by User
259
-
260
- ```javascript
261
- // Simple query using author_id index
262
- db.posts.find({
263
- author_id: ObjectId("507f1f77bcf86cd799439011"),
264
- status: "published"
265
- })
266
- .sort({ published_at: -1 })
267
- .limit(20)
268
-
269
- // With author info (using aggregation)
270
- db.posts.aggregate([
271
- {
272
- $match: {
273
- author_id: ObjectId("507f1f77bcf86cd799439011"),
274
- status: "published"
275
- }
276
- },
277
- { $sort: { published_at: -1 } },
278
- { $limit: 20 },
279
- {
280
- $lookup: {
281
- from: "users",
282
- localField: "author_id",
283
- foreignField: "_id",
284
- as: "author"
285
- }
286
- },
287
- { $unwind: "$author" },
288
- {
289
- $project: {
290
- title: 1,
291
- slug: 1,
292
- excerpt: 1,
293
- tags: 1,
294
- stats: 1,
295
- published_at: 1,
296
- "author.username": 1,
297
- "author.profile.full_name": 1,
298
- "author.profile.avatar_url": 1
299
- }
300
- }
301
- ])
302
- ```
303
-
304
- ### Query 2: Find Recent Posts with Author Info
305
-
306
- ```javascript
307
- db.posts.aggregate([
308
- { $match: { status: "published" } },
309
- { $sort: { published_at: -1 } },
310
- { $limit: 20 },
311
- {
312
- $lookup: {
313
- from: "users",
314
- localField: "author_id",
315
- foreignField: "_id",
316
- as: "author"
317
- }
318
- },
319
- { $unwind: "$author" },
320
- {
321
- $project: {
322
- title: 1,
323
- slug: 1,
324
- excerpt: 1,
325
- tags: 1,
326
- stats: 1,
327
- published_at: 1,
328
- "author.username": 1,
329
- "author.profile.full_name": 1,
330
- "author.profile.avatar_url": 1
331
- }
332
- }
333
- ])
334
- ```
335
-
336
- ### Query 3: Find Posts by Tag
337
-
338
- ```javascript
339
- // Using tags index
340
- db.posts.find({
341
- tags: "mongodb",
342
- status: "published"
343
- })
344
- .sort({ published_at: -1 })
345
- .limit(20)
346
- ```
347
-
348
- ### Query 4: Find Comments for Post
349
-
350
- ```javascript
351
- // Using post_id index
352
- db.comments.find({
353
- post_id: ObjectId("507f191e810c19729de860ea")
354
- })
355
- .sort({ created_at: 1 })
356
- .limit(50)
357
-
358
- // With nested replies
359
- db.comments.aggregate([
360
- {
361
- $match: {
362
- post_id: ObjectId("507f191e810c19729de860ea"),
363
- parent_comment_id: null // Top-level comments only
364
- }
365
- },
366
- { $sort: { created_at: 1 } },
367
- {
368
- $lookup: {
369
- from: "comments",
370
- localField: "_id",
371
- foreignField: "parent_comment_id",
372
- as: "replies"
373
- }
374
- },
375
- {
376
- $project: {
377
- content: 1,
378
- author_display: 1,
379
- stats: 1,
380
- created_at: 1,
381
- replies: {
382
- $slice: ["$replies", 5] // Limit replies to 5
383
- }
384
- }
385
- }
386
- ])
387
- ```
388
-
389
- ### Query 5: User's Feed (Posts from Followed Users)
390
-
391
- ```javascript
392
- // Assuming follows collection: { follower_id, following_id }
393
-
394
- // Step 1: Get followed user IDs
395
- const followedUsers = db.follows.find({
396
- follower_id: ObjectId("507f1f77bcf86cd799439011")
397
- }).map(f => f.following_id)
398
-
399
- // Step 2: Get posts from followed users
400
- db.posts.find({
401
- author_id: { $in: followedUsers },
402
- status: "published"
403
- })
404
- .sort({ published_at: -1 })
405
- .limit(50)
406
-
407
- // Combined aggregation
408
- db.follows.aggregate([
409
- {
410
- $match: {
411
- follower_id: ObjectId("507f1f77bcf86cd799439011")
412
- }
413
- },
414
- {
415
- $lookup: {
416
- from: "posts",
417
- localField: "following_id",
418
- foreignField: "author_id",
419
- as: "posts"
420
- }
421
- },
422
- { $unwind: "$posts" },
423
- { $match: { "posts.status": "published" } },
424
- { $replaceRoot: { newRoot: "$posts" } },
425
- { $sort: { published_at: -1 } },
426
- { $limit: 50 }
427
- ])
428
- ```
429
-
430
- ### Query 6: Popular Posts (Most Likes/Comments)
431
-
432
- ```javascript
433
- // Most liked posts in last 7 days
434
- db.posts.find({
435
- status: "published",
436
- published_at: {
437
- $gte: new Date(Date.now() - 7 * 24 * 60 * 60 * 1000)
438
- }
439
- })
440
- .sort({ "stats.like_count": -1 })
441
- .limit(10)
442
-
443
- // Most commented posts
444
- db.posts.find({
445
- status: "published"
446
- })
447
- .sort({ "stats.comment_count": -1 })
448
- .limit(10)
449
-
450
- // Combined score (likes + comments)
451
- db.posts.aggregate([
452
- { $match: { status: "published" } },
453
- {
454
- $addFields: {
455
- popularity_score: {
456
- $add: ["$stats.like_count", { $multiply: ["$stats.comment_count", 2] }]
457
- }
458
- }
459
- },
460
- { $sort: { popularity_score: -1 } },
461
- { $limit: 10 }
462
- ])
463
- ```
464
-
465
- ### Query 7: Full-Text Search
466
-
467
- ```javascript
468
- // Search posts by text
469
- db.posts.find({
470
- $text: { $search: "mongodb database tutorial" },
471
- status: "published"
472
- })
473
- .sort({ score: { $meta: "textScore" } })
474
- .limit(20)
475
-
476
- // With text score
477
- db.posts.find({
478
- $text: { $search: "mongodb database tutorial" },
479
- status: "published"
480
- },
481
- {
482
- score: { $meta: "textScore" }
483
- })
484
- .sort({ score: { $meta: "textScore" } })
485
- .limit(20)
486
- ```
487
-
488
- ---
489
-
490
- ## Aggregation Pipeline Examples
491
-
492
- ### Example 1: User Statistics
493
-
494
- ```javascript
495
- // Calculate user statistics
496
- db.posts.aggregate([
497
- {
498
- $match: {
499
- author_id: ObjectId("507f1f77bcf86cd799439011"),
500
- status: "published"
501
- }
502
- },
503
- {
504
- $group: {
505
- _id: "$author_id",
506
- total_posts: { $sum: 1 },
507
- total_views: { $sum: "$stats.view_count" },
508
- total_likes: { $sum: "$stats.like_count" },
509
- total_comments: { $sum: "$stats.comment_count" },
510
- avg_likes_per_post: { $avg: "$stats.like_count" },
511
- most_popular_post: { $max: "$stats.view_count" }
512
- }
513
- }
514
- ])
515
- ```
516
-
517
- ### Example 2: Tag Popularity
518
-
519
- ```javascript
520
- // Find most popular tags
521
- db.posts.aggregate([
522
- { $match: { status: "published" } },
523
- { $unwind: "$tags" },
524
- {
525
- $group: {
526
- _id: "$tags",
527
- post_count: { $sum: 1 },
528
- total_likes: { $sum: "$stats.like_count" }
529
- }
530
- },
531
- { $sort: { post_count: -1 } },
532
- { $limit: 20 }
533
- ])
534
- ```
535
-
536
- ### Example 3: Monthly Post Count
537
-
538
- ```javascript
539
- // Posts per month
540
- db.posts.aggregate([
541
- { $match: { status: "published" } },
542
- {
543
- $group: {
544
- _id: {
545
- year: { $year: "$published_at" },
546
- month: { $month: "$published_at" }
547
- },
548
- count: { $sum: 1 }
549
- }
550
- },
551
- { $sort: { "_id.year": -1, "_id.month": -1 } }
552
- ])
553
- ```
554
-
555
- ### Example 4: Top Authors by Engagement
556
-
557
- ```javascript
558
- // Find authors with highest engagement
559
- db.posts.aggregate([
560
- { $match: { status: "published" } },
561
- {
562
- $group: {
563
- _id: "$author_id",
564
- post_count: { $sum: 1 },
565
- total_likes: { $sum: "$stats.like_count" },
566
- total_comments: { $sum: "$stats.comment_count" },
567
- total_views: { $sum: "$stats.view_count" }
568
- }
569
- },
570
- {
571
- $addFields: {
572
- engagement_score: {
573
- $add: [
574
- "$total_likes",
575
- { $multiply: ["$total_comments", 2] },
576
- { $divide: ["$total_views", 10] }
577
- ]
578
- }
579
- }
580
- },
581
- { $sort: { engagement_score: -1 } },
582
- { $limit: 10 },
583
- {
584
- $lookup: {
585
- from: "users",
586
- localField: "_id",
587
- foreignField: "_id",
588
- as: "author"
589
- }
590
- },
591
- { $unwind: "$author" },
592
- {
593
- $project: {
594
- "author.username": 1,
595
- "author.profile.full_name": 1,
596
- post_count: 1,
597
- total_likes: 1,
598
- total_comments: 1,
599
- total_views: 1,
600
- engagement_score: 1
601
- }
602
- }
603
- ])
604
- ```
605
-
606
- ---
607
-
608
- ## Update Operations
609
-
610
- ### Update Post Stats (Increment Like Count)
611
-
612
- ```javascript
613
- // Increment like count
614
- db.posts.updateOne(
615
- { _id: ObjectId("507f191e810c19729de860ea") },
616
- {
617
- $inc: { "stats.like_count": 1 },
618
- $set: { updated_at: new Date() }
619
- }
620
- )
621
-
622
- // Add to recent_likes array (keep last 10)
623
- db.posts.updateOne(
624
- { _id: ObjectId("507f191e810c19729de860ea") },
625
- {
626
- $push: {
627
- recent_likes: {
628
- $each: [{
629
- user_id: ObjectId("507f1f77bcf86cd799439012"),
630
- username: "bob_smith",
631
- liked_at: new Date()
632
- }],
633
- $position: 0,
634
- $slice: 10
635
- }
636
- },
637
- $inc: { "stats.like_count": 1 }
638
- }
639
- )
640
- ```
641
-
642
- ### Update Comment Count
643
-
644
- ```javascript
645
- // Increment comment count when comment is added
646
- db.posts.updateOne(
647
- { _id: ObjectId("507f191e810c19729de860ea") },
648
- {
649
- $inc: { "stats.comment_count": 1 },
650
- $set: { updated_at: new Date() }
651
- }
652
- )
653
- ```
654
-
655
- ### Update User Stats
656
-
657
- ```javascript
658
- // Increment post count when post is published
659
- db.users.updateOne(
660
- { _id: ObjectId("507f1f77bcf86cd799439011") },
661
- {
662
- $inc: { "stats.post_count": 1 },
663
- $set: { updated_at: new Date() }
664
- }
665
- )
666
- ```
667
-
668
- ### Update Author Display Info (Eventual Consistency)
669
-
670
- ```javascript
671
- // When user changes username/avatar, update all comments
672
- db.comments.updateMany(
673
- { author_id: ObjectId("507f1f77bcf86cd799439011") },
674
- {
675
- $set: {
676
- "author_display.username": "alice_developer",
677
- "author_display.avatar_url": "https://cdn.example.com/avatars/alice-new.jpg"
678
- }
679
- }
680
- )
681
- ```
682
-
683
- ---
684
-
685
- ## Schema Validation
686
-
687
- ### users Collection Validation
688
-
689
- ```javascript
690
- db.createCollection("users", {
691
- validator: {
692
- $jsonSchema: {
693
- bsonType: "object",
694
- required: ["username", "email", "password_hash", "created_at"],
695
- properties: {
696
- username: {
697
- bsonType: "string",
698
- minLength: 3,
699
- maxLength: 30,
700
- pattern: "^[a-zA-Z0-9_]+$",
701
- description: "Username must be 3-30 alphanumeric characters"
702
- },
703
- email: {
704
- bsonType: "string",
705
- pattern: "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
706
- description: "Must be a valid email address"
707
- },
708
- password_hash: {
709
- bsonType: "string",
710
- description: "Hashed password"
711
- },
712
- profile: {
713
- bsonType: "object",
714
- properties: {
715
- full_name: { bsonType: "string" },
716
- bio: { bsonType: "string", maxLength: 500 },
717
- avatar_url: { bsonType: "string" },
718
- location: { bsonType: "string" },
719
- website: { bsonType: "string" }
720
- }
721
- },
722
- stats: {
723
- bsonType: "object",
724
- properties: {
725
- post_count: { bsonType: "int", minimum: 0 },
726
- follower_count: { bsonType: "int", minimum: 0 },
727
- following_count: { bsonType: "int", minimum: 0 }
728
- }
729
- },
730
- created_at: { bsonType: "date" },
731
- updated_at: { bsonType: "date" }
732
- }
733
- }
734
- }
735
- })
736
- ```
737
-
738
- ### posts Collection Validation
739
-
740
- ```javascript
741
- db.createCollection("posts", {
742
- validator: {
743
- $jsonSchema: {
744
- bsonType: "object",
745
- required: ["author_id", "title", "slug", "content", "status", "created_at"],
746
- properties: {
747
- author_id: { bsonType: "objectId" },
748
- title: {
749
- bsonType: "string",
750
- minLength: 1,
751
- maxLength: 200
752
- },
753
- slug: {
754
- bsonType: "string",
755
- pattern: "^[a-z0-9-]+$"
756
- },
757
- content: { bsonType: "string" },
758
- excerpt: { bsonType: "string", maxLength: 500 },
759
- status: {
760
- enum: ["draft", "published", "archived"]
761
- },
762
- tags: {
763
- bsonType: "array",
764
- maxItems: 20,
765
- items: { bsonType: "string" }
766
- },
767
- stats: {
768
- bsonType: "object",
769
- properties: {
770
- view_count: { bsonType: "int", minimum: 0 },
771
- like_count: { bsonType: "int", minimum: 0 },
772
- comment_count: { bsonType: "int", minimum: 0 }
773
- }
774
- },
775
- published_at: { bsonType: "date" },
776
- created_at: { bsonType: "date" },
777
- updated_at: { bsonType: "date" }
778
- }
779
- }
780
- }
781
- })
782
- ```
783
-
784
- ---
785
-
786
- ## Performance Considerations
787
-
788
- ### Query Optimization
789
-
790
- **Use projection to limit returned fields:**
791
- ```javascript
792
- // ❌ BAD: Returns entire document
793
- db.posts.find({ status: "published" })
794
-
795
- // ✅ GOOD: Returns only needed fields
796
- db.posts.find(
797
- { status: "published" },
798
- { title: 1, slug: 1, excerpt: 1, published_at: 1 }
799
- )
800
- ```
801
-
802
- **Use covered queries (index-only):**
803
- ```javascript
804
- // Create index
805
- db.posts.createIndex({ status: 1, published_at: -1, title: 1 })
806
-
807
- // Query uses only indexed fields
808
- db.posts.find(
809
- { status: "published" },
810
- { _id: 0, title: 1, published_at: 1 }
811
- ).sort({ published_at: -1 })
812
- ```
813
-
814
- **Use explain() to analyze queries:**
815
- ```javascript
816
- db.posts.find({ status: "published" }).explain("executionStats")
817
- ```
818
-
819
- ### Denormalization Trade-offs
820
-
821
- **Embedded author display data:**
822
- - ✅ **Pro**: Fast reads (no JOIN)
823
- - ❌ **Con**: Must update when author changes username/avatar
824
- - ✅ **Acceptable**: Display data changes infrequently
825
-
826
- **Embedded stats:**
827
- - ✅ **Pro**: Fast display of counts
828
- - ❌ **Con**: Must update on every like/comment
829
- - ✅ **Acceptable**: Atomic updates with $inc
830
-
831
- ### Sharding Strategy
832
-
833
- **Shard key for posts collection:**
834
- ```javascript
835
- // Shard by author_id (good for user-specific queries)
836
- sh.shardCollection("blog.posts", { author_id: 1, _id: 1 })
837
-
838
- // OR shard by published_at (good for time-based queries)
839
- sh.shardCollection("blog.posts", { published_at: -1, _id: 1 })
840
- ```
841
-
842
- ---
843
-
844
- ## Summary
845
-
846
- **Key Design Decisions:**
847
- - ✅ **Embed**: Profile data (one-to-one), tags (one-to-few), recent likes (bounded)
848
- - ✅ **Reference**: Posts (one-to-many), comments (unbounded), full likes history
849
- - ✅ **Hybrid**: Author display data (reference + embedded for performance)
850
-
851
- **Indexing Strategy:**
852
- - ✅ Unique indexes on email, username, slug
853
- - ✅ Compound indexes for common query patterns
854
- - ✅ Text indexes for full-text search
855
-
856
- **Performance Tips:**
857
- - ✅ Use projection to limit returned fields
858
- - ✅ Use aggregation pipelines for complex queries
859
- - ✅ Denormalize for read performance (accept eventual consistency)
860
- - ✅ Use $inc for atomic counter updates
861
- - ✅ Monitor query performance with explain()
862
-
863
- **Trade-offs:**
864
- - **Embedding**: Faster reads, harder updates, bounded size
865
- - **Referencing**: Flexible queries, slower reads (JOINs), unbounded growth
866
- - **Hybrid**: Best of both worlds, complexity in maintaining consistency
867
-
868
-
1
+ # NoSQL Document Store Example: Blog Application
2
+
3
+ ## Overview
4
+
5
+ This example demonstrates a complete blog application using MongoDB as a document store. It covers schema design decisions (embedding vs referencing), aggregation pipelines, indexing strategies, and common query patterns.
6
+
7
+ ---
8
+
9
+ ## Application Requirements
10
+
11
+ **Features:**
12
+ - Users can create accounts
13
+ - Users can write blog posts
14
+ - Users can comment on posts
15
+ - Users can like posts and comments
16
+ - Posts can have tags
17
+ - Users can follow other users
18
+
19
+ **Query Patterns:**
20
+ - Find all posts by a user
21
+ - Find recent posts with author info
22
+ - Find posts by tag
23
+ - Find comments for a post
24
+ - Find user's feed (posts from followed users)
25
+ - Count likes on posts
26
+ - Find popular posts (most likes/comments)
27
+
28
+ ---
29
+
30
+ ## Schema Design
31
+
32
+ ### Collections
33
+
34
+ **users** - User accounts
35
+ **posts** - Blog posts
36
+ **comments** - Comments on posts
37
+ **tags** - Post tags
38
+
39
+ ### Design Decisions
40
+
41
+ #### Decision 1: User Profile (Embedding)
42
+
43
+ **Embed profile data in user document:**
44
+
45
+ ```javascript
46
+ // ✅ GOOD: Embed profile (one-to-one, always accessed together)
47
+ {
48
+ "_id": ObjectId("507f1f77bcf86cd799439011"),
49
+ "username": "alice_dev",
50
+ "email": "alice@example.com",
51
+ "password_hash": "$2b$10$...",
52
+ "profile": {
53
+ "full_name": "Alice Johnson",
54
+ "bio": "Full-stack developer passionate about web technologies",
55
+ "avatar_url": "https://cdn.example.com/avatars/alice.jpg",
56
+ "location": "San Francisco, CA",
57
+ "website": "https://alice.dev"
58
+ },
59
+ "stats": {
60
+ "post_count": 42,
61
+ "follower_count": 156,
62
+ "following_count": 89
63
+ },
64
+ "created_at": ISODate("2024-01-15T10:00:00Z"),
65
+ "updated_at": ISODate("2024-01-20T14:30:00Z")
66
+ }
67
+ ```
68
+
69
+ **Why embed?**
70
+ - ✅ Profile is always accessed with user data
71
+ - ✅ One-to-one relationship
72
+ - ✅ Profile data doesn't change frequently
73
+ - ✅ Single query to get complete user info
74
+
75
+ #### Decision 2: Blog Posts (Separate Collection)
76
+
77
+ **Store posts in separate collection with user reference:**
78
+
79
+ ```javascript
80
+ // ✅ GOOD: Separate collection (one-to-many, accessed independently)
81
+ {
82
+ "_id": ObjectId("507f191e810c19729de860ea"),
83
+ "author_id": ObjectId("507f1f77bcf86cd799439011"),
84
+ "title": "Getting Started with MongoDB",
85
+ "slug": "getting-started-with-mongodb",
86
+ "content": "MongoDB is a document database that provides...",
87
+ "excerpt": "Learn the basics of MongoDB document modeling...",
88
+ "status": "published", // draft, published, archived
89
+ "tags": ["mongodb", "database", "nosql"], // Embedded array (one-to-few)
90
+ "metadata": {
91
+ "read_time_minutes": 5,
92
+ "word_count": 1200,
93
+ "featured_image": "https://cdn.example.com/images/mongodb-intro.jpg"
94
+ },
95
+ "stats": {
96
+ "view_count": 1523,
97
+ "like_count": 87,
98
+ "comment_count": 12
99
+ },
100
+ "published_at": ISODate("2024-01-18T09:00:00Z"),
101
+ "created_at": ISODate("2024-01-15T14:00:00Z"),
102
+ "updated_at": ISODate("2024-01-18T09:00:00Z")
103
+ }
104
+ ```
105
+
106
+ **Why separate collection?**
107
+ - ✅ One-to-many relationship (user has many posts)
108
+ - ✅ Posts are accessed independently
109
+ - ✅ Posts can be queried without user data
110
+ - ✅ Avoids unbounded array growth in user document
111
+
112
+ **Why embed tags?**
113
+ - ✅ One-to-few relationship (< 20 tags per post)
114
+ - ✅ Tags are always displayed with post
115
+ - ✅ Simple array, no complex queries needed
116
+
117
+ #### Decision 3: Comments (Separate Collection with Hybrid Approach)
118
+
119
+ **Store comments separately but embed author display info:**
120
+
121
+ ```javascript
122
+ // ✅ GOOD: Hybrid approach (reference + embedded display data)
123
+ {
124
+ "_id": ObjectId("507f191e810c19729de860eb"),
125
+ "post_id": ObjectId("507f191e810c19729de860ea"),
126
+ "author_id": ObjectId("507f1f77bcf86cd799439011"),
127
+ "author_display": { // Embedded for fast display
128
+ "username": "alice_dev",
129
+ "avatar_url": "https://cdn.example.com/avatars/alice.jpg"
130
+ },
131
+ "content": "Great article! Very helpful for beginners.",
132
+ "parent_comment_id": null, // For nested replies
133
+ "stats": {
134
+ "like_count": 5
135
+ },
136
+ "created_at": ISODate("2024-01-18T10:30:00Z"),
137
+ "updated_at": ISODate("2024-01-18T10:30:00Z")
138
+ }
139
+ ```
140
+
141
+ **Why separate collection?**
142
+ - ✅ One-to-many relationship (post has many comments)
143
+ - ✅ Unbounded growth (posts can have hundreds of comments)
144
+ - ✅ Comments can be paginated
145
+ - ✅ Avoids 16MB document size limit
146
+
147
+ **Why embed author display data?**
148
+ - ✅ Fast display without JOIN
149
+ - ✅ Display data rarely changes
150
+ - ✅ Small data footprint
151
+ - ✅ Can update if needed (eventual consistency acceptable)
152
+
153
+ #### Decision 4: Likes (Embedded Array with Limit)
154
+
155
+ **Embed recent likes, reference for full list:**
156
+
157
+ ```javascript
158
+ // In posts collection
159
+ {
160
+ "_id": ObjectId("507f191e810c19729de860ea"),
161
+ "title": "Getting Started with MongoDB",
162
+ // ... other fields ...
163
+ "stats": {
164
+ "like_count": 87 // Total count
165
+ },
166
+ "recent_likes": [ // Last 10 likes for quick display
167
+ {
168
+ "user_id": ObjectId("507f1f77bcf86cd799439012"),
169
+ "username": "bob_smith",
170
+ "liked_at": ISODate("2024-01-20T15:00:00Z")
171
+ },
172
+ // ... up to 10 recent likes
173
+ ]
174
+ }
175
+
176
+ // Separate likes collection for full history
177
+ {
178
+ "_id": ObjectId("507f191e810c19729de860ec"),
179
+ "post_id": ObjectId("507f191e810c19729de860ea"),
180
+ "user_id": ObjectId("507f1f77bcf86cd799439012"),
181
+ "created_at": ISODate("2024-01-20T15:00:00Z")
182
+ }
183
+ ```
184
+
185
+ **Why hybrid approach?**
186
+ - ✅ Fast display of recent likes (embedded)
187
+ - ✅ Full history available (separate collection)
188
+ - ✅ Bounded array size (max 10 items)
189
+ - ✅ Efficient counting (stats.like_count)
190
+
191
+ ---
192
+
193
+ ## Indexing Strategy
194
+
195
+ ### users Collection
196
+
197
+ ```javascript
198
+ // Unique index on email (for login)
199
+ db.users.createIndex({ "email": 1 }, { unique: true })
200
+
201
+ // Unique index on username (for profile URLs)
202
+ db.users.createIndex({ "username": 1 }, { unique: true })
203
+
204
+ // Index on created_at (for sorting new users)
205
+ db.users.createIndex({ "created_at": -1 })
206
+ ```
207
+
208
+ ### posts Collection
209
+
210
+ ```javascript
211
+ // Compound index for user's posts (sorted by date)
212
+ db.posts.createIndex({ "author_id": 1, "published_at": -1 })
213
+
214
+ // Index on slug (for URL lookups)
215
+ db.posts.createIndex({ "slug": 1 }, { unique: true })
216
+
217
+ // Index on tags (for tag-based queries)
218
+ db.posts.createIndex({ "tags": 1 })
219
+
220
+ // Index on status and published_at (for published posts feed)
221
+ db.posts.createIndex({ "status": 1, "published_at": -1 })
222
+
223
+ // Text index for full-text search
224
+ db.posts.createIndex({
225
+ "title": "text",
226
+ "content": "text",
227
+ "excerpt": "text"
228
+ })
229
+ ```
230
+
231
+ ### comments Collection
232
+
233
+ ```javascript
234
+ // Compound index for post's comments (sorted by date)
235
+ db.comments.createIndex({ "post_id": 1, "created_at": 1 })
236
+
237
+ // Index on author_id (for user's comments)
238
+ db.comments.createIndex({ "author_id": 1, "created_at": -1 })
239
+
240
+ // Index on parent_comment_id (for nested replies)
241
+ db.comments.createIndex({ "parent_comment_id": 1 })
242
+ ```
243
+
244
+ ### likes Collection
245
+
246
+ ```javascript
247
+ // Compound unique index (prevent duplicate likes)
248
+ db.likes.createIndex({ "post_id": 1, "user_id": 1 }, { unique: true })
249
+
250
+ // Index on user_id (for user's liked posts)
251
+ db.likes.createIndex({ "user_id": 1, "created_at": -1 })
252
+ ```
253
+
254
+ ---
255
+
256
+ ## Common Queries
257
+
258
+ ### Query 1: Find All Posts by User
259
+
260
+ ```javascript
261
+ // Simple query using author_id index
262
+ db.posts.find({
263
+ author_id: ObjectId("507f1f77bcf86cd799439011"),
264
+ status: "published"
265
+ })
266
+ .sort({ published_at: -1 })
267
+ .limit(20)
268
+
269
+ // With author info (using aggregation)
270
+ db.posts.aggregate([
271
+ {
272
+ $match: {
273
+ author_id: ObjectId("507f1f77bcf86cd799439011"),
274
+ status: "published"
275
+ }
276
+ },
277
+ { $sort: { published_at: -1 } },
278
+ { $limit: 20 },
279
+ {
280
+ $lookup: {
281
+ from: "users",
282
+ localField: "author_id",
283
+ foreignField: "_id",
284
+ as: "author"
285
+ }
286
+ },
287
+ { $unwind: "$author" },
288
+ {
289
+ $project: {
290
+ title: 1,
291
+ slug: 1,
292
+ excerpt: 1,
293
+ tags: 1,
294
+ stats: 1,
295
+ published_at: 1,
296
+ "author.username": 1,
297
+ "author.profile.full_name": 1,
298
+ "author.profile.avatar_url": 1
299
+ }
300
+ }
301
+ ])
302
+ ```
303
+
304
+ ### Query 2: Find Recent Posts with Author Info
305
+
306
+ ```javascript
307
+ db.posts.aggregate([
308
+ { $match: { status: "published" } },
309
+ { $sort: { published_at: -1 } },
310
+ { $limit: 20 },
311
+ {
312
+ $lookup: {
313
+ from: "users",
314
+ localField: "author_id",
315
+ foreignField: "_id",
316
+ as: "author"
317
+ }
318
+ },
319
+ { $unwind: "$author" },
320
+ {
321
+ $project: {
322
+ title: 1,
323
+ slug: 1,
324
+ excerpt: 1,
325
+ tags: 1,
326
+ stats: 1,
327
+ published_at: 1,
328
+ "author.username": 1,
329
+ "author.profile.full_name": 1,
330
+ "author.profile.avatar_url": 1
331
+ }
332
+ }
333
+ ])
334
+ ```
335
+
336
+ ### Query 3: Find Posts by Tag
337
+
338
+ ```javascript
339
+ // Using tags index
340
+ db.posts.find({
341
+ tags: "mongodb",
342
+ status: "published"
343
+ })
344
+ .sort({ published_at: -1 })
345
+ .limit(20)
346
+ ```
347
+
348
+ ### Query 4: Find Comments for Post
349
+
350
+ ```javascript
351
+ // Using post_id index
352
+ db.comments.find({
353
+ post_id: ObjectId("507f191e810c19729de860ea")
354
+ })
355
+ .sort({ created_at: 1 })
356
+ .limit(50)
357
+
358
+ // With nested replies
359
+ db.comments.aggregate([
360
+ {
361
+ $match: {
362
+ post_id: ObjectId("507f191e810c19729de860ea"),
363
+ parent_comment_id: null // Top-level comments only
364
+ }
365
+ },
366
+ { $sort: { created_at: 1 } },
367
+ {
368
+ $lookup: {
369
+ from: "comments",
370
+ localField: "_id",
371
+ foreignField: "parent_comment_id",
372
+ as: "replies"
373
+ }
374
+ },
375
+ {
376
+ $project: {
377
+ content: 1,
378
+ author_display: 1,
379
+ stats: 1,
380
+ created_at: 1,
381
+ replies: {
382
+ $slice: ["$replies", 5] // Limit replies to 5
383
+ }
384
+ }
385
+ }
386
+ ])
387
+ ```
388
+
389
+ ### Query 5: User's Feed (Posts from Followed Users)
390
+
391
+ ```javascript
392
+ // Assuming follows collection: { follower_id, following_id }
393
+
394
+ // Step 1: Get followed user IDs
395
+ const followedUsers = db.follows.find({
396
+ follower_id: ObjectId("507f1f77bcf86cd799439011")
397
+ }).map(f => f.following_id)
398
+
399
+ // Step 2: Get posts from followed users
400
+ db.posts.find({
401
+ author_id: { $in: followedUsers },
402
+ status: "published"
403
+ })
404
+ .sort({ published_at: -1 })
405
+ .limit(50)
406
+
407
+ // Combined aggregation
408
+ db.follows.aggregate([
409
+ {
410
+ $match: {
411
+ follower_id: ObjectId("507f1f77bcf86cd799439011")
412
+ }
413
+ },
414
+ {
415
+ $lookup: {
416
+ from: "posts",
417
+ localField: "following_id",
418
+ foreignField: "author_id",
419
+ as: "posts"
420
+ }
421
+ },
422
+ { $unwind: "$posts" },
423
+ { $match: { "posts.status": "published" } },
424
+ { $replaceRoot: { newRoot: "$posts" } },
425
+ { $sort: { published_at: -1 } },
426
+ { $limit: 50 }
427
+ ])
428
+ ```
429
+
430
+ ### Query 6: Popular Posts (Most Likes/Comments)
431
+
432
+ ```javascript
433
+ // Most liked posts in last 7 days
434
+ db.posts.find({
435
+ status: "published",
436
+ published_at: {
437
+ $gte: new Date(Date.now() - 7 * 24 * 60 * 60 * 1000)
438
+ }
439
+ })
440
+ .sort({ "stats.like_count": -1 })
441
+ .limit(10)
442
+
443
+ // Most commented posts
444
+ db.posts.find({
445
+ status: "published"
446
+ })
447
+ .sort({ "stats.comment_count": -1 })
448
+ .limit(10)
449
+
450
+ // Combined score (likes + comments)
451
+ db.posts.aggregate([
452
+ { $match: { status: "published" } },
453
+ {
454
+ $addFields: {
455
+ popularity_score: {
456
+ $add: ["$stats.like_count", { $multiply: ["$stats.comment_count", 2] }]
457
+ }
458
+ }
459
+ },
460
+ { $sort: { popularity_score: -1 } },
461
+ { $limit: 10 }
462
+ ])
463
+ ```
464
+
465
+ ### Query 7: Full-Text Search
466
+
467
+ ```javascript
468
+ // Search posts by text
469
+ db.posts.find({
470
+ $text: { $search: "mongodb database tutorial" },
471
+ status: "published"
472
+ })
473
+ .sort({ score: { $meta: "textScore" } })
474
+ .limit(20)
475
+
476
+ // With text score
477
+ db.posts.find({
478
+ $text: { $search: "mongodb database tutorial" },
479
+ status: "published"
480
+ },
481
+ {
482
+ score: { $meta: "textScore" }
483
+ })
484
+ .sort({ score: { $meta: "textScore" } })
485
+ .limit(20)
486
+ ```
487
+
488
+ ---
489
+
490
+ ## Aggregation Pipeline Examples
491
+
492
+ ### Example 1: User Statistics
493
+
494
+ ```javascript
495
+ // Calculate user statistics
496
+ db.posts.aggregate([
497
+ {
498
+ $match: {
499
+ author_id: ObjectId("507f1f77bcf86cd799439011"),
500
+ status: "published"
501
+ }
502
+ },
503
+ {
504
+ $group: {
505
+ _id: "$author_id",
506
+ total_posts: { $sum: 1 },
507
+ total_views: { $sum: "$stats.view_count" },
508
+ total_likes: { $sum: "$stats.like_count" },
509
+ total_comments: { $sum: "$stats.comment_count" },
510
+ avg_likes_per_post: { $avg: "$stats.like_count" },
511
+ most_popular_post: { $max: "$stats.view_count" }
512
+ }
513
+ }
514
+ ])
515
+ ```
516
+
517
+ ### Example 2: Tag Popularity
518
+
519
+ ```javascript
520
+ // Find most popular tags
521
+ db.posts.aggregate([
522
+ { $match: { status: "published" } },
523
+ { $unwind: "$tags" },
524
+ {
525
+ $group: {
526
+ _id: "$tags",
527
+ post_count: { $sum: 1 },
528
+ total_likes: { $sum: "$stats.like_count" }
529
+ }
530
+ },
531
+ { $sort: { post_count: -1 } },
532
+ { $limit: 20 }
533
+ ])
534
+ ```
535
+
536
+ ### Example 3: Monthly Post Count
537
+
538
+ ```javascript
539
+ // Posts per month
540
+ db.posts.aggregate([
541
+ { $match: { status: "published" } },
542
+ {
543
+ $group: {
544
+ _id: {
545
+ year: { $year: "$published_at" },
546
+ month: { $month: "$published_at" }
547
+ },
548
+ count: { $sum: 1 }
549
+ }
550
+ },
551
+ { $sort: { "_id.year": -1, "_id.month": -1 } }
552
+ ])
553
+ ```
554
+
555
+ ### Example 4: Top Authors by Engagement
556
+
557
+ ```javascript
558
+ // Find authors with highest engagement
559
+ db.posts.aggregate([
560
+ { $match: { status: "published" } },
561
+ {
562
+ $group: {
563
+ _id: "$author_id",
564
+ post_count: { $sum: 1 },
565
+ total_likes: { $sum: "$stats.like_count" },
566
+ total_comments: { $sum: "$stats.comment_count" },
567
+ total_views: { $sum: "$stats.view_count" }
568
+ }
569
+ },
570
+ {
571
+ $addFields: {
572
+ engagement_score: {
573
+ $add: [
574
+ "$total_likes",
575
+ { $multiply: ["$total_comments", 2] },
576
+ { $divide: ["$total_views", 10] }
577
+ ]
578
+ }
579
+ }
580
+ },
581
+ { $sort: { engagement_score: -1 } },
582
+ { $limit: 10 },
583
+ {
584
+ $lookup: {
585
+ from: "users",
586
+ localField: "_id",
587
+ foreignField: "_id",
588
+ as: "author"
589
+ }
590
+ },
591
+ { $unwind: "$author" },
592
+ {
593
+ $project: {
594
+ "author.username": 1,
595
+ "author.profile.full_name": 1,
596
+ post_count: 1,
597
+ total_likes: 1,
598
+ total_comments: 1,
599
+ total_views: 1,
600
+ engagement_score: 1
601
+ }
602
+ }
603
+ ])
604
+ ```
605
+
606
+ ---
607
+
608
+ ## Update Operations
609
+
610
+ ### Update Post Stats (Increment Like Count)
611
+
612
+ ```javascript
613
+ // Increment like count
614
+ db.posts.updateOne(
615
+ { _id: ObjectId("507f191e810c19729de860ea") },
616
+ {
617
+ $inc: { "stats.like_count": 1 },
618
+ $set: { updated_at: new Date() }
619
+ }
620
+ )
621
+
622
+ // Add to recent_likes array (keep last 10)
623
+ db.posts.updateOne(
624
+ { _id: ObjectId("507f191e810c19729de860ea") },
625
+ {
626
+ $push: {
627
+ recent_likes: {
628
+ $each: [{
629
+ user_id: ObjectId("507f1f77bcf86cd799439012"),
630
+ username: "bob_smith",
631
+ liked_at: new Date()
632
+ }],
633
+ $position: 0,
634
+ $slice: 10
635
+ }
636
+ },
637
+ $inc: { "stats.like_count": 1 }
638
+ }
639
+ )
640
+ ```
641
+
642
+ ### Update Comment Count
643
+
644
+ ```javascript
645
+ // Increment comment count when comment is added
646
+ db.posts.updateOne(
647
+ { _id: ObjectId("507f191e810c19729de860ea") },
648
+ {
649
+ $inc: { "stats.comment_count": 1 },
650
+ $set: { updated_at: new Date() }
651
+ }
652
+ )
653
+ ```
654
+
655
+ ### Update User Stats
656
+
657
+ ```javascript
658
+ // Increment post count when post is published
659
+ db.users.updateOne(
660
+ { _id: ObjectId("507f1f77bcf86cd799439011") },
661
+ {
662
+ $inc: { "stats.post_count": 1 },
663
+ $set: { updated_at: new Date() }
664
+ }
665
+ )
666
+ ```
667
+
668
+ ### Update Author Display Info (Eventual Consistency)
669
+
670
+ ```javascript
671
+ // When user changes username/avatar, update all comments
672
+ db.comments.updateMany(
673
+ { author_id: ObjectId("507f1f77bcf86cd799439011") },
674
+ {
675
+ $set: {
676
+ "author_display.username": "alice_developer",
677
+ "author_display.avatar_url": "https://cdn.example.com/avatars/alice-new.jpg"
678
+ }
679
+ }
680
+ )
681
+ ```
682
+
683
+ ---
684
+
685
+ ## Schema Validation
686
+
687
+ ### users Collection Validation
688
+
689
+ ```javascript
690
+ db.createCollection("users", {
691
+ validator: {
692
+ $jsonSchema: {
693
+ bsonType: "object",
694
+ required: ["username", "email", "password_hash", "created_at"],
695
+ properties: {
696
+ username: {
697
+ bsonType: "string",
698
+ minLength: 3,
699
+ maxLength: 30,
700
+ pattern: "^[a-zA-Z0-9_]+$",
701
+ description: "Username must be 3-30 alphanumeric characters"
702
+ },
703
+ email: {
704
+ bsonType: "string",
705
+ pattern: "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
706
+ description: "Must be a valid email address"
707
+ },
708
+ password_hash: {
709
+ bsonType: "string",
710
+ description: "Hashed password"
711
+ },
712
+ profile: {
713
+ bsonType: "object",
714
+ properties: {
715
+ full_name: { bsonType: "string" },
716
+ bio: { bsonType: "string", maxLength: 500 },
717
+ avatar_url: { bsonType: "string" },
718
+ location: { bsonType: "string" },
719
+ website: { bsonType: "string" }
720
+ }
721
+ },
722
+ stats: {
723
+ bsonType: "object",
724
+ properties: {
725
+ post_count: { bsonType: "int", minimum: 0 },
726
+ follower_count: { bsonType: "int", minimum: 0 },
727
+ following_count: { bsonType: "int", minimum: 0 }
728
+ }
729
+ },
730
+ created_at: { bsonType: "date" },
731
+ updated_at: { bsonType: "date" }
732
+ }
733
+ }
734
+ }
735
+ })
736
+ ```
737
+
738
+ ### posts Collection Validation
739
+
740
+ ```javascript
741
+ db.createCollection("posts", {
742
+ validator: {
743
+ $jsonSchema: {
744
+ bsonType: "object",
745
+ required: ["author_id", "title", "slug", "content", "status", "created_at"],
746
+ properties: {
747
+ author_id: { bsonType: "objectId" },
748
+ title: {
749
+ bsonType: "string",
750
+ minLength: 1,
751
+ maxLength: 200
752
+ },
753
+ slug: {
754
+ bsonType: "string",
755
+ pattern: "^[a-z0-9-]+$"
756
+ },
757
+ content: { bsonType: "string" },
758
+ excerpt: { bsonType: "string", maxLength: 500 },
759
+ status: {
760
+ enum: ["draft", "published", "archived"]
761
+ },
762
+ tags: {
763
+ bsonType: "array",
764
+ maxItems: 20,
765
+ items: { bsonType: "string" }
766
+ },
767
+ stats: {
768
+ bsonType: "object",
769
+ properties: {
770
+ view_count: { bsonType: "int", minimum: 0 },
771
+ like_count: { bsonType: "int", minimum: 0 },
772
+ comment_count: { bsonType: "int", minimum: 0 }
773
+ }
774
+ },
775
+ published_at: { bsonType: "date" },
776
+ created_at: { bsonType: "date" },
777
+ updated_at: { bsonType: "date" }
778
+ }
779
+ }
780
+ }
781
+ })
782
+ ```
783
+
784
+ ---
785
+
786
+ ## Performance Considerations
787
+
788
+ ### Query Optimization
789
+
790
+ **Use projection to limit returned fields:**
791
+ ```javascript
792
+ // ❌ BAD: Returns entire document
793
+ db.posts.find({ status: "published" })
794
+
795
+ // ✅ GOOD: Returns only needed fields
796
+ db.posts.find(
797
+ { status: "published" },
798
+ { title: 1, slug: 1, excerpt: 1, published_at: 1 }
799
+ )
800
+ ```
801
+
802
+ **Use covered queries (index-only):**
803
+ ```javascript
804
+ // Create index
805
+ db.posts.createIndex({ status: 1, published_at: -1, title: 1 })
806
+
807
+ // Query uses only indexed fields
808
+ db.posts.find(
809
+ { status: "published" },
810
+ { _id: 0, title: 1, published_at: 1 }
811
+ ).sort({ published_at: -1 })
812
+ ```
813
+
814
+ **Use explain() to analyze queries:**
815
+ ```javascript
816
+ db.posts.find({ status: "published" }).explain("executionStats")
817
+ ```
818
+
819
+ ### Denormalization Trade-offs
820
+
821
+ **Embedded author display data:**
822
+ - ✅ **Pro**: Fast reads (no JOIN)
823
+ - ❌ **Con**: Must update when author changes username/avatar
824
+ - ✅ **Acceptable**: Display data changes infrequently
825
+
826
+ **Embedded stats:**
827
+ - ✅ **Pro**: Fast display of counts
828
+ - ❌ **Con**: Must update on every like/comment
829
+ - ✅ **Acceptable**: Atomic updates with $inc
830
+
831
+ ### Sharding Strategy
832
+
833
+ **Shard key for posts collection:**
834
+ ```javascript
835
+ // Shard by author_id (good for user-specific queries)
836
+ sh.shardCollection("blog.posts", { author_id: 1, _id: 1 })
837
+
838
+ // OR shard by published_at (good for time-based queries)
839
+ sh.shardCollection("blog.posts", { published_at: -1, _id: 1 })
840
+ ```
841
+
842
+ ---
843
+
844
+ ## Summary
845
+
846
+ **Key Design Decisions:**
847
+ - ✅ **Embed**: Profile data (one-to-one), tags (one-to-few), recent likes (bounded)
848
+ - ✅ **Reference**: Posts (one-to-many), comments (unbounded), full likes history
849
+ - ✅ **Hybrid**: Author display data (reference + embedded for performance)
850
+
851
+ **Indexing Strategy:**
852
+ - ✅ Unique indexes on email, username, slug
853
+ - ✅ Compound indexes for common query patterns
854
+ - ✅ Text indexes for full-text search
855
+
856
+ **Performance Tips:**
857
+ - ✅ Use projection to limit returned fields
858
+ - ✅ Use aggregation pipelines for complex queries
859
+ - ✅ Denormalize for read performance (accept eventual consistency)
860
+ - ✅ Use $inc for atomic counter updates
861
+ - ✅ Monitor query performance with explain()
862
+
863
+ **Trade-offs:**
864
+ - **Embedding**: Faster reads, harder updates, bounded size
865
+ - **Referencing**: Flexible queries, slower reads (JOINs), unbounded growth
866
+ - **Hybrid**: Best of both worlds, complexity in maintaining consistency
867
+
868
+