Skip to content

Commit d9b385d

Browse files
committed
docs: refine references
1 parent b27a259 commit d9b385d

9 files changed

+116
-60
lines changed

README.md

+26-24
Original file line numberDiff line numberDiff line change
@@ -49,22 +49,22 @@
4949

5050
1. Language: [TypeScript](docs/typescript.md), [JavaScript](docs/javascript.md), [HTML](docs/html.md), [CSS](docs/css.md)
5151
2. Runtime: [Bun](docs/bun.md) / [Deno](docs/deno.md) / [Node.js](docs/nodejs.md)
52-
3. Format & Lint: [Biome](docs/biome.md) & [Prettier](docs/prettier.md)
53-
4. Bundler: [Vite](docs/vite.md)
54-
5. Frontend: [React](docs/react.md)
55-
6. Frontend Meta Framework: [Remix](docs/remix.md) / [Next.js](docs/nextjs.md)
52+
3. Frontend: [React](docs/react.md)
53+
4. Frontend Meta Framework: [Remix](docs/remix.md) / [Next.js](docs/nextjs.md)
5654
- Backend with built-in server-side features
57-
7. Styling: [Tailwind CSS](docs/tailwind.md)
55+
5. Styling: [Tailwind CSS](docs/tailwind.md)
5856
- UI Component: [shadcn/ui](docs/shadcn-ui.md)
5957
- Icon: [unplugin-icons](docs/unplugin-icons.md)
6058
- Email: [React Email](docs/react-email.md)
6159
- Test: [Storybook](docs/storybook.md)
60+
6. Format and Lint: [Prettier](docs/prettier.md) / [ESLint](docs/eslint.md) / [Biome](docs/biome.md) / [Oxc](docs/oxc.md)
61+
7. Bundler: [Vite](docs/vite.md) / [Turbopack](docs/turbopack.md)
6262
8. Auth: [Better Auth](docs/better-auth.md)
6363
9. Database ORM: [Prisma](docs/prisma.md) with [ZenStack](docs/zenstack.md)
6464
10. Database/DBMS: [PostgreSQL](docs/postgresql.md)
6565
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)
6666

67-
### Alternative
67+
### Optional: Alternative
6868

6969
1. Frontend: [Svelte](docs/svelte.md) / [Vue.js](docs/vuejs.md) / [Angular](docs/angular.md) / [SolidJS](docs/solidjs.md) / [Qwik](docs/qwik.md)
7070
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:
8585
4. Bare Metal: [Hetzner](docs/hetzner.md) / [Vultr](docs/vultr.md) / [Scaleway](docs/scaleway.md)
8686
5. Automation: [Kamal Deploy](docs/kamal-deploy.md) / [Ansible](docs/ansible.md)
8787
6. OS: [Debian](docs/debian.md) / [Ubuntu](docs/ubuntu.md)
88-
7. Web Server & Proxy: [Caddy](docs/caddy.md) / [Nginx](docs/nginx.md)
88+
7. Web Server and Proxy: [Caddy](docs/caddy.md) / [Nginx](docs/nginx.md)
8989
8. SSL/TLS Certificate: [Let's Encrypt](docs/lets-encrypt.md)
9090

91-
### Separated Backend
91+
### Optional: Separated Backend
9292

93-
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)
94-
2. [GraphQL](docs/graphql.md): [Apollo](docs/apollo.md), [Pothos](docs/pothos.md), [Sofa](docs/sofa.md)
95-
3. JS-based Fully Featured: [RedwoodJS](docs/redwoodjs.md) / [AdonisJS](docs/adonisjs.md)
96-
4. Non-JS Fully Featured: [Laravel](docs/laravel.md) / [Rails](docs/rails.md) / [Django](docs/django.md)
97-
5. Non-JS Lightweight: [Gin](docs/gin.md) / [Fiber](docs/fiber.md) / [Echo](docs/echo.md)
98-
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)
93+
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)
94+
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
95+
3. [GraphQL](docs/graphql.md): [Apollo](docs/apollo.md), [Pothos](docs/pothos.md), [Sofa](docs/sofa.md)
96+
4. JS-based Fully Featured: [RedwoodJS](docs/redwoodjs.md) / [AdonisJS](docs/adonisjs.md)
97+
5. Non-JS Fully Featured: [Laravel](docs/laravel.md) / [Rails](docs/rails.md) / [Django](docs/django.md)
98+
6. Non-JS Lightweight: [Gin](docs/gin.md) / [Fiber](docs/fiber.md) / [Echo](docs/echo.md)
9999

100-
### Features
100+
### Optional: Workflow and Features
101101

102102
1. Monorepo: [moonrepo](docs/moonrepo.md) with [Changesets](docs/changesets.md)
103-
2. Secrets & Environment Variables: [.env](docs/env.md) / [t3-env](docs/t3-env.md) / [unplugin-environment](docs/unplugin-environment.md)
103+
2. Secrets and Environment Variables: [.env](docs/env.md) / [t3-env](docs/t3-env.md) / [unplugin-environment](docs/unplugin-environment.md)
104104
3. Data Validation: [Zod](docs/zod.md)
105105
4. Form Validation: [Conform](docs/conform.md)
106106
5. Testing: [Vitest](docs/vitest.md) with [Testing Library](docs/testing-library.md), [Playwright](docs/playwright.md), [MSW](docs/msw.md)
107-
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)
107+
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)
108108
7. Performance: [Million.js](docs/millionjs.md)
109109
8. Search: [Meilisearch](docs/meilisearch.md) / [Typesense](docs/typesense.md)
110110
9. Process: [Effect](docs/effect.md)
@@ -113,18 +113,18 @@ Manual:
113113
12. Internationalization (i18n): [Lingui](docs/lingui.md)
114114
13. Accessibility (a11y): [Lighthouse](docs/lighthouse.md)
115115
14. Realtime: [SSE](docs/sse.md) / [Socket.IO](docs/socket-io.md) / [Liveblocks](docs/liveblocks.md) / [InstantDB](docs/instantdb.md) / [Electric](docs/electric.md)
116-
15. Cache & Message Queues: [Redis](docs/redis.md) / [BullMQ](docs/bullmq.md) / In-Memory
116+
15. Cache and Message Queues: [Redis](docs/redis.md) / [BullMQ](docs/bullmq.md) / In-Memory
117117
16. Mobile: [React Native](docs/react-native.md) with [Expo](docs/expo.md)
118118
17. Storage: Unix File System
119119
18. Mailers: SMTP
120120
19. Documentation: [Nextra](docs/nextra.md)
121121

122-
### 3rd Party Services
122+
### Optional: 3rd Party Services
123123

124-
1. Secrets & Environment Variables: [Infisical](docs/infisical.md) / [Doppler](docs/doppler.md)
124+
1. Secrets and Environment Variables: [Infisical](docs/infisical.md) / [Doppler](docs/doppler.md)
125125
2. Analytics: [PostHog](docs/posthog.md) / [Openpanel.dev](docs/openpanel.md) / [Simple Analytics](docs/simpleanalytics.md) / [Plausible](docs/plausible.md)
126126
3. Service Monitoring: [OpenStatus](docs/openstatus.md)
127-
4. APM, Observability, Error Tracking: [Sentry](docs/sentry.md) & [OpenTelemetry](docs/opentelemetry.md)
127+
4. APM, Observability, Error Tracking: [Sentry](docs/sentry.md) and [OpenTelemetry](docs/opentelemetry.md)
128128
5. Email: [Nodemailer](docs/nodemailer.md) / [Plunk](docs/plunk.md) / [Resend](docs/resend.md) / [Amazon SES](docs/amazon-ses.md)
129129
6. Auth: [WorkOS](docs/workos.md)
130130
7. File Storage/Upload: [Uploadcare](docs/uploadcare.md) / [Cloudinary](docs/cloudinary.md)
@@ -137,7 +137,7 @@ Manual:
137137
14. Automation: [n8n](docs/n8n.md)
138138
15. API Key Management: [Unkey](docs/unkey.md)
139139

140-
### Tools
140+
### Optional: Tools
141141

142142
1. Email: [Gmail](docs/gmail.md) / [HEY](docs/hey.md) / [ProtonMail](docs/protonmail.md)
143143
2. Credentials: [Bitwarden](docs/bitwarden.md) / [Passbolt](docs/passbolt.md)
@@ -150,8 +150,9 @@ Manual:
150150
9. Document: [DocuSeal](docs/docuseal.md) / [Papermark](docs/papermark.md)
151151
10. Launcher: [Raycast](docs/raycast.md)
152152
11. Code Editor: [VS Code](docs/vscode.md) / [NeoVim](docs/neovim.md)
153-
12. AI Code Editor: [Cursor AI](docs/cursor.md) / [Supermaven](docs/supermaven.md) / [GitHub CoPilot](docs/github-copilot.md) / [Tabnine](docs/tabnine.md)
154-
13. AI Tool: [ChatGPT](docs/chatgpt.md) / [Claude](docs/claude.md) / [Perplexity](docs/perplexity.md) / [Galileo](docs/galileo.md) / [Marblism](docs/marblism.md)
153+
12. AI Tool: [ChatGPT](docs/chatgpt.md) / [Claude](docs/claude.md) / [Perplexity](docs/perplexity.md) / [Galileo AI](docs/galileo-ai.md)
154+
13. AI Code Editor: [Cursor AI](docs/cursor.md) / [Supermaven](docs/supermaven.md) / [GitHub CoPilot](docs/github-copilot.md) / [Tabnine](docs/tabnine.md)
155+
14. AI Code Generator: [v0.dev](docs/v0.md) / [Marblism](docs/marblism.md)
155156

156157
## Guides
157158

@@ -176,6 +177,7 @@ Manual:
176177
- [`midday-ai/v1`](https://github.com/midday-ai/v1)
177178
- [`ixahmedxi/orbitkit`](https://github.com/ixahmedxi/orbitkit)
178179
- [`shadcn-ui/taxonomy`](https://github.com/shadcn-ui/taxonomy)
180+
- [LaunchFast — Astro, Next.js and SvelteKit Starter Kits](https://launchfa.st)
179181

180182
## Credits
181183

docs/directus.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Directus

docs/galileo-ai.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Galileo AI

docs/galileo.md

-1
This file was deleted.

docs/guides/workflow.md

+49-35
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,56 @@ Basic workflow of building a profitable software:
44

55
1. Understand the stack, tools, opinions, decisions, and architecture.
66
2. Setup development environment.
7-
3. Run app and test.
8-
4. Implement features.
9-
5. Deploy to production.
10-
6. Maintain, monitor, improve the app.
11-
7. Promote, sell, increase visibility.
12-
8. Run business with paying customers.
7+
3. Run applications.
8+
4. Test with real data and users.
9+
5. Implement features.
10+
6. Deploy to production.
11+
7. Maintain, monitor, improve the app.
12+
8. Promote, sell, increase visibility.
13+
9. Run business with paying customers.
1314

14-
Future expectations for truly comparable with Laravel, Rails, Django, RedwoodJS:
15+
## Packages
1516

16-
- Beginner-friendly yet comprehensive documentation and learning resources.
17-
- Links to ecosystem of packages and extensions.
18-
- CLI tool for scaffolding and code generation.
17+
Future expectations for JavaScript/TypeScript full stack frameworks to be truly comparable with Laravel, Rails, Django, Spring:
18+
19+
- Straightforward tutorials.
20+
- Beginner-friendly learning resources.
21+
- Comprehensive documentation.
1922
- Predefined packages ready to use.
23+
- Links to existing ecosystem of packages and extensions.
24+
- CLI tool for scaffolding and code generation.
25+
- Well-funded development.
26+
27+
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.
28+
29+
All packages would be published to <https://jsr.io/@dogokit> by default,
2030

21-
For Dogokit (`dk`), if Animal objects or safari theme are being used, similar to [Laravel](../laravel.md) products and [RedwoodJS](../redwoodjs.md) CLI tools:
22-
23-
1. `compass`: App Routing with Remix/Next.js
24-
2. `habitat`: UI Templates with Tailwind CSS, Form Handling, Storybook
25-
3. `brush`: Formatter, Linter
26-
4. `den`: Development Environment, Container, Deployment, CI/CD
27-
5. `cave`: Secrets/Credential Management, Environment Variables, Secure Notes
28-
6. `fin`: Code Generator, CLI, Prompt, Utility, Bundler, Monorepo
29-
7. `paw`: Database ORM, Migration
30-
8. `claw`: Authentication, Authorization, RBAC, Security
31-
9. `snout`: API Docs, Database ERD
32-
10. `fur`: File/Assets Storage/Upload/Management, Fonts, Icons, Placeholder
33-
11. `tracker`: Search, Filter
34-
12. `mane`: Metadata, Open Graph, SEO
35-
13. `howl`: Email
36-
14. `burrow`: Background Jobs, Queue
37-
15. `sonar`: Realtime, Notification, Broadcast, Webhook
38-
16. `hop`: Link/URL Shortener/Management
39-
17. `eye`: Product Analytics, Conversion Tracking, Feature Flags, A/B Testing
40-
18. `tail`: Logging, Monitoring, Observability, Error Tracking
41-
19. `scent`: Performance Optimization, Caching
42-
20. `pouch`: Payment, Billing, Subscription
43-
21. `bark`: Internationalization (i18n), Localization (l10n)
44-
22. `cage`: Unit Testing, Functional Testing, E2E Testing
45-
23. Field Guide: Learning Resources
31+
1. Field Guide: Learning Resources
32+
2. `@dogokit/starter`: The starter kit app
33+
- Breeze / Jetstream
34+
3. `@dogokit/compass`: Application Routing with React Router / Remix / Next.js
35+
- Inertia
36+
4. `@dogokit/habitat`: UI Templates with Tailwind CSS, Form Handling, Dashboard, Storybook
37+
- shadcn UI / justd
38+
5. `@dogokit/brush`: Formatter, Linter
39+
6. `@dogokit/den`: Development Environment, Container, Deployment, CI/CD
40+
7. `@dogokit/fin`: Code Generator, CLI, Prompt, Utility, Bundler, Monorepo
41+
8. `@dogokit/cave`: Secrets/Credential Management, Environment Variables, Secure Notes
42+
9. `@dogokit/paw`: Database ORM, Migration
43+
10. `@dogokit/claw`: Authentication, Authorization, RBAC, Security
44+
11. `@dogokit/snout`: API Docs/Specification, Database ERD/Visualization
45+
12. `@dogokit/hop`: Link/URL Shortener/Management
46+
13. `@dogokit/fur`: File/Assets Storage/Upload/Management, Fonts, Icons, Placeholder
47+
14. `@dogokit/tracker`: Search, Filter, Pagination Helper
48+
15. `@dogokit/mane`: Metadata, Open Graph, SEO
49+
16. `@dogokit/howl`: Email Transaction & Marketing
50+
17. `@dogokit/burrow`: Background Jobs, Queue
51+
18. `@dogokit/sonar`: Real-time, Notification, Broadcast, Webhook
52+
19. `@dogokit/eye`: Product Analytics, Conversion Tracking, Feature Flags, A/B Testing
53+
20. `@dogokit/tail`: Logging, Monitoring, Observability, Error Tracking
54+
21. `@dogokit/pouch`: Payment, Billing, Subscription with Stripe, Lemonsqueezey, Xendit
55+
- Cashier
56+
22. `@dogokit/cage`: Unit Testing, Functional Testing, E2E Testing
57+
- Dusk
58+
23. `@dogokit/bark`: Internationalization (i18n), Localization (l10n)
59+
24. `@dogokit/scent`: Performance Optimization, Caching

docs/hono.md

+28
Original file line numberDiff line numberDiff line change
@@ -1 +1,29 @@
11
# Hono
2+
3+
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.
4+
5+
Fast, but not only fast.
6+
7+
```ts
8+
import { Hono } from "hono";
9+
const app = new Hono();
10+
11+
app.get("/", (c) => c.json({ message: "Hello!" }));
12+
13+
export default app;
14+
```
15+
16+
Read the official [Get Started](https://hono.dev/docs) guide.
17+
18+
References:
19+
20+
- [Hono Examples](https://hono.dev/guides/examples)
21+
- [Hono Best Practices](https://hono.dev/docs/guides/best-practices)
22+
- [Build an HTTP server using Hono and Bun](https://bun.sh/guides/ecosystem/hono)
23+
24+
Recommended packages:
25+
26+
- [`@hono/zod-openapi`: Hono Zod OpenAPI](https://hono.dev/examples/zod-openapi)
27+
- [`@hono/swagger-ui`: Hono Swagger UI Middleware](https://hono.dev/examples/swagger-ui)
28+
- [`@scalar/hono-api-reference`: Scalar Hono API Reference Plugin](https://npmjs.com/package/@scalar/hono-api-reference)
29+
- [`stoker`: Utilities for Hono and @hono/zod-openapi](https://github.com/w3cj/stoker)

docs/oxc.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Oxc
2+
3+
The JavaScript Oxidation Compiler (Oxc) is a collection of high-performance tools for the JavaScript language written in Rust.

docs/turbopack.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Turbopack

docs/v0.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# v0.dev
2+
3+
v0 by Vercel want to empower every builder to learn coding best practices, create beautiful interfaces, and fully functioning apps.
4+
5+
Links:
6+
7+
- [v0.dev](https://v0.dev)

0 commit comments

Comments
 (0)