From d9b385db7f83312af61e8750441da38627bd2225 Mon Sep 17 00:00:00 2001
From: M Haidar Hanif <git@mhaidarhanif.com>
Date: Thu, 31 Oct 2024 00:40:10 +0700
Subject: [PATCH] docs: refine references
---
README.md | 50 ++++++++++++------------
docs/directus.md | 1 +
docs/galileo-ai.md | 1 +
docs/galileo.md | 1 -
docs/guides/workflow.md | 84 ++++++++++++++++++++++++-----------------
docs/hono.md | 28 ++++++++++++++
docs/oxc.md | 3 ++
docs/turbopack.md | 1 +
docs/v0.md | 7 ++++
9 files changed, 116 insertions(+), 60 deletions(-)
create mode 100644 docs/directus.md
create mode 100644 docs/galileo-ai.md
delete mode 100644 docs/galileo.md
create mode 100644 docs/oxc.md
create mode 100644 docs/turbopack.md
create mode 100644 docs/v0.md
diff --git a/README.md b/README.md
index a8fd847..891a2d9 100644
--- a/README.md
+++ b/README.md
@@ -49,22 +49,22 @@
1. Language: [TypeScript](docs/typescript.md), [JavaScript](docs/javascript.md), [HTML](docs/html.md), [CSS](docs/css.md)
2. Runtime: [Bun](docs/bun.md) / [Deno](docs/deno.md) / [Node.js](docs/nodejs.md)
-3. Format & Lint: [Biome](docs/biome.md) & [Prettier](docs/prettier.md)
-4. Bundler: [Vite](docs/vite.md)
-5. Frontend: [React](docs/react.md)
-6. Frontend Meta Framework: [Remix](docs/remix.md) / [Next.js](docs/nextjs.md)
+3. Frontend: [React](docs/react.md)
+4. Frontend Meta Framework: [Remix](docs/remix.md) / [Next.js](docs/nextjs.md)
- Backend with built-in server-side features
-7. Styling: [Tailwind CSS](docs/tailwind.md)
+5. Styling: [Tailwind CSS](docs/tailwind.md)
- UI Component: [shadcn/ui](docs/shadcn-ui.md)
- Icon: [unplugin-icons](docs/unplugin-icons.md)
- Email: [React Email](docs/react-email.md)
- Test: [Storybook](docs/storybook.md)
+6. Format and Lint: [Prettier](docs/prettier.md) / [ESLint](docs/eslint.md) / [Biome](docs/biome.md) / [Oxc](docs/oxc.md)
+7. Bundler: [Vite](docs/vite.md) / [Turbopack](docs/turbopack.md)
8. Auth: [Better Auth](docs/better-auth.md)
9. Database ORM: [Prisma](docs/prisma.md) with [ZenStack](docs/zenstack.md)
10. Database/DBMS: [PostgreSQL](docs/postgresql.md)
11. Container: [Docker](docs/docker.md) with [Docker Compose](docs/docker-compose.md), using [OrbStack](docs/orbstack.md) or [Docker Desktop](docs/docker-desktop.md)
-### Alternative
+### Optional: Alternative
1. Frontend: [Svelte](docs/svelte.md) / [Vue.js](docs/vuejs.md) / [Angular](docs/angular.md) / [SolidJS](docs/solidjs.md) / [Qwik](docs/qwik.md)
2. Frontend Meta Framework: [SvelteKit](docs/sveltekit.md), [Nuxt](docs/nuxt.md), [SolidStart](docs/solidstart.md), [Qwik City](docs/qwik-city.md)
@@ -85,26 +85,26 @@ Manual:
4. Bare Metal: [Hetzner](docs/hetzner.md) / [Vultr](docs/vultr.md) / [Scaleway](docs/scaleway.md)
5. Automation: [Kamal Deploy](docs/kamal-deploy.md) / [Ansible](docs/ansible.md)
6. OS: [Debian](docs/debian.md) / [Ubuntu](docs/ubuntu.md)
-7. Web Server & Proxy: [Caddy](docs/caddy.md) / [Nginx](docs/nginx.md)
+7. Web Server and Proxy: [Caddy](docs/caddy.md) / [Nginx](docs/nginx.md)
8. SSL/TLS Certificate: [Let's Encrypt](docs/lets-encrypt.md)
-### Separated Backend
+### Optional: Separated Backend
-1. [REST API](docs/rest-api.md): [Hono](docs/hono.md) with [Swagger](docs/swagger.md) & [Scalar](docs/scalar.md) that can be generated by [ZenStack](docs/zenstack.md)
-2. [GraphQL](docs/graphql.md): [Apollo](docs/apollo.md), [Pothos](docs/pothos.md), [Sofa](docs/sofa.md)
-3. JS-based Fully Featured: [RedwoodJS](docs/redwoodjs.md) / [AdonisJS](docs/adonisjs.md)
-4. Non-JS Fully Featured: [Laravel](docs/laravel.md) / [Rails](docs/rails.md) / [Django](docs/django.md)
-5. Non-JS Lightweight: [Gin](docs/gin.md) / [Fiber](docs/fiber.md) / [Echo](docs/echo.md)
-6. BaaS: [Supabase](docs/supabase.md) / [PocketBase](docs/pocketbase.md) / [Firebase](docs/firebase.md) / [Strapi](docs/strapi.md) / [Payload](docs/payload.md) / [Keel](docs/keel.md)
+1. BaaS: [Keel](docs/keel.md) / [Directus](docs/directus.md) / [Strapi](docs/strapi.md) / [Payload](docs/payload.md) / [PocketBase](docs/pocketbase.md) / [Supabase](docs/supabase.md) / [Firebase](docs/firebase.md)
+2. [REST API](docs/rest-api.md): [Hono](docs/hono.md) with [Swagger](docs/swagger.md) generated by [ZenStack](docs/zenstack.md) and [Scalar](docs/scalar.md) for refined UX
+3. [GraphQL](docs/graphql.md): [Apollo](docs/apollo.md), [Pothos](docs/pothos.md), [Sofa](docs/sofa.md)
+4. JS-based Fully Featured: [RedwoodJS](docs/redwoodjs.md) / [AdonisJS](docs/adonisjs.md)
+5. Non-JS Fully Featured: [Laravel](docs/laravel.md) / [Rails](docs/rails.md) / [Django](docs/django.md)
+6. Non-JS Lightweight: [Gin](docs/gin.md) / [Fiber](docs/fiber.md) / [Echo](docs/echo.md)
-### Features
+### Optional: Workflow and Features
1. Monorepo: [moonrepo](docs/moonrepo.md) with [Changesets](docs/changesets.md)
-2. Secrets & Environment Variables: [.env](docs/env.md) / [t3-env](docs/t3-env.md) / [unplugin-environment](docs/unplugin-environment.md)
+2. Secrets and Environment Variables: [.env](docs/env.md) / [t3-env](docs/t3-env.md) / [unplugin-environment](docs/unplugin-environment.md)
3. Data Validation: [Zod](docs/zod.md)
4. Form Validation: [Conform](docs/conform.md)
5. Testing: [Vitest](docs/vitest.md) with [Testing Library](docs/testing-library.md), [Playwright](docs/playwright.md), [MSW](docs/msw.md)
-6. CLI & Prompt: [Term.Ink](docs/term-ink.md) / [Clack](docs/clack.md) / [Commander.js](docs/commanderjs.md) / [oclif](docs/oclif.md) / [Inquirer](docs/inquirer.md)
+6. CLI and Prompt: [Term.Ink](docs/term-ink.md) / [Clack](docs/clack.md) / [Commander.js](docs/commanderjs.md) / [oclif](docs/oclif.md) / [Inquirer](docs/inquirer.md)
7. Performance: [Million.js](docs/millionjs.md)
8. Search: [Meilisearch](docs/meilisearch.md) / [Typesense](docs/typesense.md)
9. Process: [Effect](docs/effect.md)
@@ -113,18 +113,18 @@ Manual:
12. Internationalization (i18n): [Lingui](docs/lingui.md)
13. Accessibility (a11y): [Lighthouse](docs/lighthouse.md)
14. Realtime: [SSE](docs/sse.md) / [Socket.IO](docs/socket-io.md) / [Liveblocks](docs/liveblocks.md) / [InstantDB](docs/instantdb.md) / [Electric](docs/electric.md)
-15. Cache & Message Queues: [Redis](docs/redis.md) / [BullMQ](docs/bullmq.md) / In-Memory
+15. Cache and Message Queues: [Redis](docs/redis.md) / [BullMQ](docs/bullmq.md) / In-Memory
16. Mobile: [React Native](docs/react-native.md) with [Expo](docs/expo.md)
17. Storage: Unix File System
18. Mailers: SMTP
19. Documentation: [Nextra](docs/nextra.md)
-### 3rd Party Services
+### Optional: 3rd Party Services
-1. Secrets & Environment Variables: [Infisical](docs/infisical.md) / [Doppler](docs/doppler.md)
+1. Secrets and Environment Variables: [Infisical](docs/infisical.md) / [Doppler](docs/doppler.md)
2. Analytics: [PostHog](docs/posthog.md) / [Openpanel.dev](docs/openpanel.md) / [Simple Analytics](docs/simpleanalytics.md) / [Plausible](docs/plausible.md)
3. Service Monitoring: [OpenStatus](docs/openstatus.md)
-4. APM, Observability, Error Tracking: [Sentry](docs/sentry.md) & [OpenTelemetry](docs/opentelemetry.md)
+4. APM, Observability, Error Tracking: [Sentry](docs/sentry.md) and [OpenTelemetry](docs/opentelemetry.md)
5. Email: [Nodemailer](docs/nodemailer.md) / [Plunk](docs/plunk.md) / [Resend](docs/resend.md) / [Amazon SES](docs/amazon-ses.md)
6. Auth: [WorkOS](docs/workos.md)
7. File Storage/Upload: [Uploadcare](docs/uploadcare.md) / [Cloudinary](docs/cloudinary.md)
@@ -137,7 +137,7 @@ Manual:
14. Automation: [n8n](docs/n8n.md)
15. API Key Management: [Unkey](docs/unkey.md)
-### Tools
+### Optional: Tools
1. Email: [Gmail](docs/gmail.md) / [HEY](docs/hey.md) / [ProtonMail](docs/protonmail.md)
2. Credentials: [Bitwarden](docs/bitwarden.md) / [Passbolt](docs/passbolt.md)
@@ -150,8 +150,9 @@ Manual:
9. Document: [DocuSeal](docs/docuseal.md) / [Papermark](docs/papermark.md)
10. Launcher: [Raycast](docs/raycast.md)
11. Code Editor: [VS Code](docs/vscode.md) / [NeoVim](docs/neovim.md)
-12. AI Code Editor: [Cursor AI](docs/cursor.md) / [Supermaven](docs/supermaven.md) / [GitHub CoPilot](docs/github-copilot.md) / [Tabnine](docs/tabnine.md)
-13. AI Tool: [ChatGPT](docs/chatgpt.md) / [Claude](docs/claude.md) / [Perplexity](docs/perplexity.md) / [Galileo](docs/galileo.md) / [Marblism](docs/marblism.md)
+12. AI Tool: [ChatGPT](docs/chatgpt.md) / [Claude](docs/claude.md) / [Perplexity](docs/perplexity.md) / [Galileo AI](docs/galileo-ai.md)
+13. AI Code Editor: [Cursor AI](docs/cursor.md) / [Supermaven](docs/supermaven.md) / [GitHub CoPilot](docs/github-copilot.md) / [Tabnine](docs/tabnine.md)
+14. AI Code Generator: [v0.dev](docs/v0.md) / [Marblism](docs/marblism.md)
## Guides
@@ -176,6 +177,7 @@ Manual:
- [`midday-ai/v1`](https://github.com/midday-ai/v1)
- [`ixahmedxi/orbitkit`](https://github.com/ixahmedxi/orbitkit)
- [`shadcn-ui/taxonomy`](https://github.com/shadcn-ui/taxonomy)
+- [LaunchFast — Astro, Next.js and SvelteKit Starter Kits](https://launchfa.st)
## Credits
diff --git a/docs/directus.md b/docs/directus.md
new file mode 100644
index 0000000..9df37ec
--- /dev/null
+++ b/docs/directus.md
@@ -0,0 +1 @@
+# Directus
diff --git a/docs/galileo-ai.md b/docs/galileo-ai.md
new file mode 100644
index 0000000..67a7803
--- /dev/null
+++ b/docs/galileo-ai.md
@@ -0,0 +1 @@
+# Galileo AI
diff --git a/docs/galileo.md b/docs/galileo.md
deleted file mode 100644
index 1c544c4..0000000
--- a/docs/galileo.md
+++ /dev/null
@@ -1 +0,0 @@
-# Galileo
diff --git a/docs/guides/workflow.md b/docs/guides/workflow.md
index 325dbe9..84ac9a4 100644
--- a/docs/guides/workflow.md
+++ b/docs/guides/workflow.md
@@ -4,42 +4,56 @@ Basic workflow of building a profitable software:
1. Understand the stack, tools, opinions, decisions, and architecture.
2. Setup development environment.
-3. Run app and test.
-4. Implement features.
-5. Deploy to production.
-6. Maintain, monitor, improve the app.
-7. Promote, sell, increase visibility.
-8. Run business with paying customers.
+3. Run applications.
+4. Test with real data and users.
+5. Implement features.
+6. Deploy to production.
+7. Maintain, monitor, improve the app.
+8. Promote, sell, increase visibility.
+9. Run business with paying customers.
-Future expectations for truly comparable with Laravel, Rails, Django, RedwoodJS:
+## Packages
-- Beginner-friendly yet comprehensive documentation and learning resources.
-- Links to ecosystem of packages and extensions.
-- CLI tool for scaffolding and code generation.
+Future expectations for JavaScript/TypeScript full stack frameworks to be truly comparable with Laravel, Rails, Django, Spring:
+
+- Straightforward tutorials.
+- Beginner-friendly learning resources.
+- Comprehensive documentation.
- Predefined packages ready to use.
+- Links to existing ecosystem of packages and extensions.
+- CLI tool for scaffolding and code generation.
+- Well-funded development.
+
+For Dogokit (`dk`), if Animal objects or safari theme are being used, similar to [Laravel](../laravel.md) products and [RedwoodJS](../redwoodjs.md) CLI tools, these are the codenames.
+
+All packages would be published to <https://jsr.io/@dogokit> by default,
-For Dogokit (`dk`), if Animal objects or safari theme are being used, similar to [Laravel](../laravel.md) products and [RedwoodJS](../redwoodjs.md) CLI tools:
-
-1. `compass`: App Routing with Remix/Next.js
-2. `habitat`: UI Templates with Tailwind CSS, Form Handling, Storybook
-3. `brush`: Formatter, Linter
-4. `den`: Development Environment, Container, Deployment, CI/CD
-5. `cave`: Secrets/Credential Management, Environment Variables, Secure Notes
-6. `fin`: Code Generator, CLI, Prompt, Utility, Bundler, Monorepo
-7. `paw`: Database ORM, Migration
-8. `claw`: Authentication, Authorization, RBAC, Security
-9. `snout`: API Docs, Database ERD
-10. `fur`: File/Assets Storage/Upload/Management, Fonts, Icons, Placeholder
-11. `tracker`: Search, Filter
-12. `mane`: Metadata, Open Graph, SEO
-13. `howl`: Email
-14. `burrow`: Background Jobs, Queue
-15. `sonar`: Realtime, Notification, Broadcast, Webhook
-16. `hop`: Link/URL Shortener/Management
-17. `eye`: Product Analytics, Conversion Tracking, Feature Flags, A/B Testing
-18. `tail`: Logging, Monitoring, Observability, Error Tracking
-19. `scent`: Performance Optimization, Caching
-20. `pouch`: Payment, Billing, Subscription
-21. `bark`: Internationalization (i18n), Localization (l10n)
-22. `cage`: Unit Testing, Functional Testing, E2E Testing
-23. Field Guide: Learning Resources
+1. Field Guide: Learning Resources
+2. `@dogokit/starter`: The starter kit app
+ - Breeze / Jetstream
+3. `@dogokit/compass`: Application Routing with React Router / Remix / Next.js
+ - Inertia
+4. `@dogokit/habitat`: UI Templates with Tailwind CSS, Form Handling, Dashboard, Storybook
+ - shadcn UI / justd
+5. `@dogokit/brush`: Formatter, Linter
+6. `@dogokit/den`: Development Environment, Container, Deployment, CI/CD
+7. `@dogokit/fin`: Code Generator, CLI, Prompt, Utility, Bundler, Monorepo
+8. `@dogokit/cave`: Secrets/Credential Management, Environment Variables, Secure Notes
+9. `@dogokit/paw`: Database ORM, Migration
+10. `@dogokit/claw`: Authentication, Authorization, RBAC, Security
+11. `@dogokit/snout`: API Docs/Specification, Database ERD/Visualization
+12. `@dogokit/hop`: Link/URL Shortener/Management
+13. `@dogokit/fur`: File/Assets Storage/Upload/Management, Fonts, Icons, Placeholder
+14. `@dogokit/tracker`: Search, Filter, Pagination Helper
+15. `@dogokit/mane`: Metadata, Open Graph, SEO
+16. `@dogokit/howl`: Email Transaction & Marketing
+17. `@dogokit/burrow`: Background Jobs, Queue
+18. `@dogokit/sonar`: Real-time, Notification, Broadcast, Webhook
+19. `@dogokit/eye`: Product Analytics, Conversion Tracking, Feature Flags, A/B Testing
+20. `@dogokit/tail`: Logging, Monitoring, Observability, Error Tracking
+21. `@dogokit/pouch`: Payment, Billing, Subscription with Stripe, Lemonsqueezey, Xendit
+ - Cashier
+22. `@dogokit/cage`: Unit Testing, Functional Testing, E2E Testing
+ - Dusk
+23. `@dogokit/bark`: Internationalization (i18n), Localization (l10n)
+24. `@dogokit/scent`: Performance Optimization, Caching
diff --git a/docs/hono.md b/docs/hono.md
index 39c36a2..8205145 100644
--- a/docs/hono.md
+++ b/docs/hono.md
@@ -1 +1,29 @@
# Hono
+
+Hono (means flame🔥 in Japanese) is a small, simple, and ultrafast web framework built on Web Standards. It works on any JavaScript runtime: Node.js, Deno, Bun, Cloudflare Workers, Fastly Compute, Vercel, Netlify, AWS Lambda, Lambda@Edge, and more.
+
+Fast, but not only fast.
+
+```ts
+import { Hono } from "hono";
+const app = new Hono();
+
+app.get("/", (c) => c.json({ message: "Hello!" }));
+
+export default app;
+```
+
+Read the official [Get Started](https://hono.dev/docs) guide.
+
+References:
+
+- [Hono Examples](https://hono.dev/guides/examples)
+- [Hono Best Practices](https://hono.dev/docs/guides/best-practices)
+- [Build an HTTP server using Hono and Bun](https://bun.sh/guides/ecosystem/hono)
+
+Recommended packages:
+
+- [`@hono/zod-openapi`: Hono Zod OpenAPI](https://hono.dev/examples/zod-openapi)
+ - [`@hono/swagger-ui`: Hono Swagger UI Middleware](https://hono.dev/examples/swagger-ui)
+ - [`@scalar/hono-api-reference`: Scalar Hono API Reference Plugin](https://npmjs.com/package/@scalar/hono-api-reference)
+ - [`stoker`: Utilities for Hono and @hono/zod-openapi](https://github.com/w3cj/stoker)
diff --git a/docs/oxc.md b/docs/oxc.md
new file mode 100644
index 0000000..717b4ba
--- /dev/null
+++ b/docs/oxc.md
@@ -0,0 +1,3 @@
+# Oxc
+
+The JavaScript Oxidation Compiler (Oxc) is a collection of high-performance tools for the JavaScript language written in Rust.
diff --git a/docs/turbopack.md b/docs/turbopack.md
new file mode 100644
index 0000000..4b6abae
--- /dev/null
+++ b/docs/turbopack.md
@@ -0,0 +1 @@
+# Turbopack
diff --git a/docs/v0.md b/docs/v0.md
new file mode 100644
index 0000000..dd9474c
--- /dev/null
+++ b/docs/v0.md
@@ -0,0 +1,7 @@
+# v0.dev
+
+v0 by Vercel want to empower every builder to learn coding best practices, create beautiful interfaces, and fully functioning apps.
+
+Links:
+
+- [v0.dev](https://v0.dev)