Skip to content

Commit 5d00a7f

Browse files
committed
docs: restructure tech stack
1 parent 85170b5 commit 5d00a7f

File tree

1 file changed

+79
-57
lines changed

1 file changed

+79
-57
lines changed

README.md

+79-57
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
## Goal
1515

16-
🐶Dogokit Akita is a highly opiniated full stack application development kit, with ecosystem from JavaScript, TypeScript, Node.js, Bun, etc. That also can be a versatile reference for building robust web-based applications, scaling from zero to millions of users.
16+
🐶Dogokit Akita is a comprehensive, opinionated full stack application development kit, encompassing JavaScript, TypeScript, Node.js, Bun, and more. It serves as a versatile reference for constructing robust web applications that can scale from zero to millions of users.
1717

1818
- Primary frontend web with Vite, React, Tailwind CSS.
1919
- Optional backend API with GraphQL or REST API.
@@ -29,81 +29,103 @@
2929

3030
## Tech Stack
3131

32-
### Core Setup
32+
- [Core](#core)
33+
- [Main](#main)
34+
- [Deployment](#deployment)
35+
- [Separated Backend](#separated-backend)
36+
- [Features](#features)
37+
- [3rd Party Services](#3rd-party-services)
38+
- [Tools](#tools)
39+
40+
### Core
3341

3442
- Frontend: React, Remix/Next.js, Tailwind CSS
3543
- Backend: Prisma, PostgreSQL, Docker
3644

37-
### Main Setup
45+
### Main
3846

3947
1. Core: [HTML](docs/html.md), [CSS](docs/css.md), [JavaScript](docs/javascript.md)
4048
2. Runtime: [TypeScript](docs/typescript.md) with [Bun](docs/bun.md)
4149
3. Tooling: [Biome](docs/biome.md) & [Prettier](docs/prettier.md)
4250
4. Frontend: [React](docs/react.md) with [Remix](docs/remix.md)
43-
5. UI: [Tailwind CSS](docs/tailwind.md)
51+
5. Styling: [Tailwind CSS](docs/tailwind.md)
4452
- Icons: [unplugin-icons](docs/unplugin-icons.md)
45-
- [shadcn/ui](docs/shadcn-ui.md)
53+
- UI Components: [shadcn/ui](docs/shadcn-ui.md)
54+
- Email: [React Email](docs/react-email.md)
4655
- [Storybook](docs/storybook.md)
47-
- [React Email](docs/react-email.md)
4856
6. Auth: [Remix Auth](docs/remix-auth.md) with [Oslo](docs/oslo.md)
4957
7. Container: [Docker](docs/docker.md)
5058
8. Database ORM: [Prisma](docs/prisma.md) with [ZenStack](docs/zenstack.md)
5159
9. Database/DBMS: [PostgreSQL](docs/postgresql.md)
5260
10. Backend with Remix/Next.js built-in server-side features
5361

54-
### Optional Setup
55-
56-
1. Separated Backend:
57-
- [REST API](docs/rest-api.md): [Hono](docs/hono.md) & [Swagger](docs/swagger.md) that can be generated by [ZenStack](docs/zenstack.md)
58-
- [GraphQL](docs/graphql.md): [Apollo](docs/apollo.md), [Pothos](docs/pothos.md), [Sofa](docs/sofa.md)
59-
- JS-based: [RedwoodJS](docs/redwoodjs.md) / [AdonisJS](docs/adonisjs.md)
60-
- Non-JS: [Laravel](docs/laravel.md) / [Rails](docs/rails.md) / [Django](docs/django.md)
61-
- BaaS: [Supabase](docs/supabase.md) / [PocketBase](docs/pocketbase.md) / [Firebase](docs/firebase.md) / [Strapi](docs/strapi.md) / [Payload](docs/payload.md)
62-
2. CLI Prompt: [Clack](docs/clack.md) / [Commander.js](docs/commanderjs.md)
63-
3. Secrets & Environment Variables: [.env](docs/env.md) / [t3-env](docs/t3-env.md) / [unplugin-environment](docs/unplugin-environment.md)
64-
4. Data Validation: [Zod](docs/zod.md)
65-
5. Form Validation: [Conform](docs/conform.md)
66-
6. Monorepo: [moonrepo](docs/moonrepo.md) with [Changesets](docs/changesets.md)
67-
7. Testing: [Vitest](docs/vitest.md) with [Testing Library](docs/testing-library.md), [Playwright](docs/playwright.md), [MSW](docs/msw.md)
68-
8. CLI & Prompt: [oclif](docs/oclif.md) / [Inquirer](docs/inquirer.md)
69-
9. Search: [Meilisearch](docs/meilisearch.md) / [Typesense](docs/typesense.md)
70-
10. Process: [Effect](docs/effect.md)
71-
11. Dependency: [Knip](docs/knip.md)
72-
12. Logging: [pino](docs/pino.md)
73-
13. Internationalization (i18n): [Lingui](docs/lingui.md)
74-
14. Accessibility (a11y): [Lighthouse](docs/lighthouse.md)
75-
15. Realtime: [SSE](docs/sse.md) / [Socket.IO](docs/socket-io.md) / [InstantDB](docs/instantdb.md) / [Electric](docs/electric.md)
76-
16. Cache & Message Queues: [Redis](docs/redis.md) / [BullMQ](docs/bullmq.md) / In-Memory
77-
17. Mobile: [React Native](docs/react-native.md) with [Expo](docs/expo.md)
78-
18. Web Server & Proxy: [Nginx](docs/nginx.md)
79-
19. Storage: Unix File System
80-
20. Mailers: SMTP
81-
21. Documentation: [Nextra](docs/nextra.md)
82-
83-
### Optional 3rd Party Services
62+
### Deployment
63+
64+
Quick:
65+
66+
1. Frontend: [Vercel](docs/vercel.md)
67+
2. Backend: [Render](docs/render.md)
68+
3. Database: [Neon](docs/neon.md)
69+
70+
Manual:
71+
72+
1. Cloud: [Google Cloud](docs/google-cloud.md) / [Amazon Web Services](docs/amazon-web-services.md)
73+
2. PaaS in VPS: [Dokku](docs/dokku.md) / [Coolify](docs/coolify.md)
74+
3. VPS: [Linode](docs/linode.md) / [DigitalOcean](docs/digitalocean.md) / [Amazon Lightsail](docs/amazon-lightsail.md)
75+
4. Bare Metal: [Hetzner](docs/hetzner.md) / [Vultr](docs/vultr.md) / [Scaleway](docs/scaleway.md)
76+
5. Automation: [Kamal Deploy](docs/kamal-deploy.md) / [Ansible](docs/ansible.md)
77+
6. OS: [Debian](docs/debian.md) / [Ubuntu](docs/ubuntu.md)
78+
79+
### Separated Backend
80+
81+
1. [REST API](docs/rest-api.md): [Hono](docs/hono.md) & [Swagger](docs/swagger.md) that can be generated by [ZenStack](docs/zenstack.md)
82+
2. [GraphQL](docs/graphql.md): [Apollo](docs/apollo.md), [Pothos](docs/pothos.md), [Sofa](docs/sofa.md)
83+
3. JS-based Fully Featured: [RedwoodJS](docs/redwoodjs.md) / [AdonisJS](docs/adonisjs.md) / etc
84+
4. Non-JS Fully Featured: [Laravel](docs/laravel.md) / [Rails](docs/rails.md) / [Django](docs/django.md) / etc
85+
5. Non-JS Lightweight: [Gin](docs/gin.md) / [Fiber](docs/fiber.md) / [Echo](docs/echo.md) / etc
86+
6. BaaS: [Supabase](docs/supabase.md) / [PocketBase](docs/pocketbase.md) / [Firebase](docs/firebase.md) / [Strapi](docs/strapi.md) / [Payload](docs/payload.md) / etc
87+
88+
### Features
89+
90+
1. CLI Prompt: [Clack](docs/clack.md) / [Commander.js](docs/commanderjs.md)
91+
2. Secrets & Environment Variables: [.env](docs/env.md) / [t3-env](docs/t3-env.md) / [unplugin-environment](docs/unplugin-environment.md)
92+
3. Data Validation: [Zod](docs/zod.md)
93+
4. Form Validation: [Conform](docs/conform.md)
94+
5. Monorepo: [moonrepo](docs/moonrepo.md) with [Changesets](docs/changesets.md)
95+
6. Testing: [Vitest](docs/vitest.md) with [Testing Library](docs/testing-library.md), [Playwright](docs/playwright.md), [MSW](docs/msw.md)
96+
7. CLI & Prompt: [oclif](docs/oclif.md) / [Inquirer](docs/inquirer.md)
97+
8. Search: [Meilisearch](docs/meilisearch.md) / [Typesense](docs/typesense.md)
98+
9. Process: [Effect](docs/effect.md)
99+
10. Dependency: [Knip](docs/knip.md)
100+
11. Logging: [pino](docs/pino.md)
101+
12. Internationalization (i18n): [Lingui](docs/lingui.md)
102+
13. Accessibility (a11y): [Lighthouse](docs/lighthouse.md)
103+
14. Realtime: [SSE](docs/sse.md) / [Socket.IO](docs/socket-io.md) / [InstantDB](docs/instantdb.md) / [Electric](docs/electric.md)
104+
15. Cache & Message Queues: [Redis](docs/redis.md) / [BullMQ](docs/bullmq.md) / In-Memory
105+
16. Mobile: [React Native](docs/react-native.md) with [Expo](docs/expo.md)
106+
17. Web Server & Proxy: [Nginx](docs/nginx.md)
107+
18. Storage: Unix File System
108+
19. Mailers: SMTP
109+
20. Documentation: [Nextra](docs/nextra.md)
110+
111+
### 3rd Party Services
84112

85113
1. Secrets & Environment Variables: [Infisical](docs/infisical.md) / [Doppler](docs/doppler.md)
86-
2. Frontend Deployment: [Vercel](docs/vercel.md)
87-
3. Backend Deployment: [Render](docs/render.md)
88-
4. Database Deployment: [Neon](docs/neon.md)
89-
5. Deployment with VPS: [Linode](docs/linode.md) / [DigitalOcean](docs/digitalocean.md) / [Amazon Lightsail](docs/amazon-lightsail.md) / [Hetzner](docs/hetzner.md)
90-
6. Deployment with PaaS in VPS: [Dokku](docs/dokku.md) / [Coolify](docs/coolify.md)
91-
7. Deployment with Cloud: [Google Cloud](docs/google-cloud.md) / [Amazon Web Services](docs/amazon-web-services.md)
92-
8. Analytics: [PostHog](docs/posthog.md) / [Openpanel.dev](docs/openpanel.md) / [Simple Analytics](docs/simpleanalytics.md) / [Plausible](docs/plausible.md)
93-
9. Service Monitoring: [OpenStatus](docs/openstatus.md)
94-
10. APM, Observability, Error Tracking: [Sentry](docs/sentry.md) & [OpenTelemetry](docs/opentelemetry.md)
95-
11. Email: [Nodemailer](docs/nodemailer.md) / [Plunk](docs/plunk.md) / [Resend](docs/resend.md) / [Amazon SES](docs/amazon-ses.md)
96-
12. Auth: [WorkOS](docs/workos.md)
97-
13. File Storage/Upload: [Uploadcare](docs/uploadcare.md) / [Cloudinary](docs/cloudinary.md)
98-
14. Background Jobs: [Quirrel.dev](docs/quirrel-dev.md) / [Trigger.dev](docs/trigger-dev.md)
99-
15. Link/URL Shortener/Management: [Dub.co](docs/dub-co.md)
100-
16. Full-Text Search: [Meilisearch](docs/meilisearch.md)
101-
17. Notification: [Novu](docs/novu.md)
102-
18. Documentation: [Mintlify](docs/mintlify.md)
103-
19. Payment: [Polar](docs/polar.md) / [Lemon Squeezy](docs/lemonsqueezy.md) / [Stripe](docs/stripe.md)
104-
20. Automation: [n8n](docs/n8n.md)
105-
106-
### Optional Tools
114+
2. Analytics: [PostHog](docs/posthog.md) / [Openpanel.dev](docs/openpanel.md) / [Simple Analytics](docs/simpleanalytics.md) / [Plausible](docs/plausible.md)
115+
3. Service Monitoring: [OpenStatus](docs/openstatus.md)
116+
4. APM, Observability, Error Tracking: [Sentry](docs/sentry.md) & [OpenTelemetry](docs/opentelemetry.md)
117+
5. Email: [Nodemailer](docs/nodemailer.md) / [Plunk](docs/plunk.md) / [Resend](docs/resend.md) / [Amazon SES](docs/amazon-ses.md)
118+
6. Auth: [WorkOS](docs/workos.md)
119+
7. File Storage/Upload: [Uploadcare](docs/uploadcare.md) / [Cloudinary](docs/cloudinary.md)
120+
8. Background Jobs: [Quirrel.dev](docs/quirrel-dev.md) / [Trigger.dev](docs/trigger-dev.md)
121+
9. Link/URL Shortener/Management: [Dub.co](docs/dub-co.md)
122+
10. Full-Text Search: [Meilisearch](docs/meilisearch.md)
123+
11. Notification: [Novu](docs/novu.md)
124+
12. Documentation: [Mintlify](docs/mintlify.md)
125+
13. Payment: [Polar](docs/polar.md) / [Lemon Squeezy](docs/lemonsqueezy.md) / [Stripe](docs/stripe.md)
126+
14. Automation: [n8n](docs/n8n.md)
127+
128+
### Tools
107129

108130
1. Credentials: [Bitwarden](docs/bitwarden.md) / [Passbolt](docs/passbolt.md)
109131
2. UI/UX Design: [Figma](docs/figma.md)

0 commit comments

Comments
 (0)