@stacksjs/buddy 0.57.3 → 0.58.19

package/README.md

@@ -1,6 +1,6 @@
-![Social Card of Stacks](./art/social.png)
+![Social Card of Stacks](./art/social.jpg)
 
-# Rapid App Development
+# Rapid App & Library Development
 
 [![npm version][npm-version-src]][npm-version-href]
 [![GitHub Actions][github-actions-src]][github-actions-href]
@@ -8,9 +8,9 @@
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
 <!-- [![Codecov][codecov-src]][codecov-href] -->
 
-_Beta coming soon._
+_Open Beta coming soon._
 
-The goal of the framework is to _help you_ create & maintain frontends, backends, and clouds—without having to worry about the boilerplate. Stacks is a rapid application development framework, meeting all your full stack needs.
+The goal of the framework is to _help you_ create & maintain frontends, backends, and clouds—without having to worry about the boilerplate. Stacks is a rapid development framework, meeting all your full stack needs.
 
 - Web & Desktop applications
 - Serverless & traditional APIs
@@ -23,32 +23,33 @@ Stacks helps you every step along the way—in beginner & expert-friendly ways,
 
 > “Convention over configuration” is the Stacks mantra. _- Chris_
 
-<!-- ![Atomic UI & FX Design](./docs/images/diagram.png) -->
+<!-- ![Atomic UI & FX Design](./docs/assets/diagram.png) -->
 
 ## Features
 
 The Stacks framework is a harmony of several “engines” to build any web and/or desktop application, in highly scalable & privacy-friendly ways. It consists of the following engines:
 
-### Stacks UI
+### Stacks Frontend
 
 _Develop dynamic UIs with helpers for atomic design, and much more._
 
-- 🧩 **Components** _a primitive to develop user interfaces_
-- 🤖 **Functions** _a primitive to develop business logic (and grant your UI superpowers)_
-- 🌐 **Web** _"a routing & templating engine that makes sense" using components—SSG & PWA ready_
-- 🖥️ **Desktop** _components as desktop elements_
+- 🧩 **Components** _primitive to develop user interfaces_
+- 🤖 **Functions** _primitive to develop business logic (and grant your UI superpowers)_
+- 🎨 **UI Kit** _modern & deeply-integrated components_
+- 🌐 **Web** _“a routing & templating engine that makes sense”_
+- 🖥️ **Desktop** _automagically build a desktop app out of your web app_
 - 📚 **Library** _auto-builds component & function libraries_
-- ⚡️ Powered by Nitro, Tauri, UnoCSS, Vite & Vue
+- ⚡️ Powered by Bun, Nitro, Tauri, UnoCSS, Vite & Vue
 
-### Stacks Functions
+### Stacks Backend
 
 _Develop serverless (or server) functions with countless helpers to build scalable & fast APIs._
 
-- 🪄 **AI** _deep OpenAI integration_
+- 🪄 **AI** _deep AI integrations & foundational model access_
 - 🤖 **APIs** _scalability & maintainability built-in_
-- 🏎️ **Cache** _Redis, DynamoDB, Upstash, SingleStore, and more—serverless_
+- 🏎️ **Cache** _Redis, DynamoDB, and more—serverless_
 - ⚙️ **CLIs** _create beautiful CLIs for Linux, Windows, and Mac—without requirements_
-- 📀 **Database** _MySQL, Postgres, PlanetScale, Supabase, Prisma, ..._
+- 📀 **Database** _SQLite, MySQL, Postgres, PlanetScale, and more_
 - 👾 **Errors** _native type-safe error handling_
 - 🗓️ **Events** _functional event (front & backend) communication_
 - 📢 **Notifications** _emails, SMSs, direct, and push notifications & webhooks_
@@ -59,7 +60,7 @@ _Develop serverless (or server) functions with countless helpers to build scalab
 - 💬 **Realtime** _“everything you need to build dynamic real-time apps”_
 - 🧭 **Router** _smart routing, file-based or Laravel-like_
 - 🔎 **Search Engine** _smart searching, advanced filtering & sorting, pagination, headless UI_
-- 💾 **Storage** _easily create & make use of local & remote storages/file systems_
+- 💾 **Storage** _a secure-by-default File API that feels right_
 - 🧪 **Tinker** _a powerful TypeScript REPL_
 - 🌪️ **Validation** _e2e type-safety (true frontend & backend harmony)_
 - 🎯 **X-Ray** _all you need to debug, log & analyze_
@@ -68,20 +69,22 @@ _Develop serverless (or server) functions with countless helpers to build scalab
 
 _Create your personal or professional Vercel-like cloud, based on MIT-licensed OSS._
 
-- ☁️ **Server** _local development server & production-ready servers_
+- ☁️ **Server** _local development server & production-ready servers out-of-the-box_
 - ⛅️ **Serverless** _on-demand, auto-scaling, zero maintenance_
-- 🚏 **CDN** _zero-config low-latency CDN, including request life-cycle hooks & optimized request compressions (Brotli & gzip)_
-- 🔀 **Domain** _version-controlled & zero-config domain management (e.g. DNS)_
-- 📧 **Email** _secure & simplistic easy-peasy@custom-domains.com mail_
+- 🚏 **CDN** _zero-config, low-latency CDN, including request life-cycle hooks & optimized request compressions (Brotli & gzip)_
+- 🔀 **Domain** _version-controlled & zero-config domain management (e.g. DNS management)_
+- 🤖 **AI** _fine-tune a foundational model using your application data_
+- 📧 **Email** _secure & simplistic <easy-peasy@custom-domains.com> mailboxes_
 - 🔐 **Firewall** _native web application firewall support_
-- 🚜 **Maintenance** _handles your cloud infrastructure via the Stacks & Serverless framework_
-- 🤖 **Infrastructure as Code** _create & maintain your cloud infrastructure with ease_
+- 📦 **Storage** _unlimited cloud storage & automatic backups_
+- 🚜 **Maintenance** _maintain your cloud infrastructure with ease using Buddy & Stacks_
+- 🚦 **Infrastructure as Code** _version-controlled cloud infrastructure_
 
 ### Stacks CI/CD
 
 _Focus on coding, not publishing._
 
-- 🚀 **Deployment Manager** _take the sweat out of production deployments (AWS, Vercel, Netlify, and more)_
+- 🚀 **Deployment Manager** _take the sweat out of production deployments (AWS, Google next?)_
 - 📫 **Release Manager** _libraries (component & function) auto-published to npm, git helpers, and more_
 
 ### Stacks DX
@@ -90,14 +93,15 @@ _Enhanced productivity for developers. No more creating boilerplate._
 
 - 💡 **IDE Integration** _auto-completions, inline docs & a powerful VS Code setup_
 - 🪄 **Zero-Config** _yet highly configurable—convention over configuration_
-- 👩🏽‍🔧 **Linter & Formatter** _auto-configured & built into your IDE_
+- 💅 **Linter & Formatter** _auto-configured & built into your IDE_
 - 💪🏼 **Type Strong** _built-in e2e type-safety_
 - ✨ **Git Workflows** _committing with ease_
 - 🚗 **Auto Imports** _your components & functions, including date, string, array, & object helpers_
 - ⏩ **Code Snippets** _say goodbye to the boilerplate—thank you Sarah Drasner_
 - 🔤 **Spell Checker** _be notified once there are typos_
 - 🛠️ **Utilities** _Collections, VueUse, and more_
-- 🧪 **Testing** _unit & e2e tests powered by Vitest & Playwright_
+- 👥 **Team Management** _manage your team & their permissions_
+- 🧪 **Testing** _unit & e2e tests powered by Bun & Playwright_
 
 No matter whether you are a beginner or an expert, the approachable Stacks design allows you to learn at your own pace, using our thorough documentation covering every aspect of the framework. Stacks is extremely beginner & expert-friendly.
 
@@ -110,16 +114,18 @@ Develop beautiful, reactive, composable UIs without learning a new set of langua
 It's incredibly easy to get started with this framework. Simply run the following command in your terminal:
 
 ```bash
-sh <(curl stacksjs.dev) my-project
+sh <(curl stacksjs.org) my-project
 
-# alternatively, if Node.js >= v18.16 is installed already,
+# alternatively, if Bun >= v1.0 is installed already,
 # you may also get started via:
-npx stacks new my-project
+bunx stacks new my-project
 ```
 
 ## 🤖 Usage
 
-The following list includes some of the most common ways to interact with the Stacks API. Meet the toolkit, Buddy:
+The following list includes some of the most common ways to interact with the Stacks API.
+
+Meet the toolkit, Buddy:
 
 ```bash
 buddy install # installs all dependencies
@@ -129,9 +135,10 @@ buddy commit # follow CLI prompts for committing changes
 buddy release # creates the releases for the stack & consequently, publishes them to npm
 buddy upgrade # auto-update all deps & the Stacks framework
 
+buddy make:model Car # scaffolds a model
 buddy make:component HelloWorld # scaffolds a component
 buddy make:function HelloWorld # scaffolds a function
-buddy make:page hello-world # scaffolds a page (https://my-project.test/hello-world)
+buddy make:view hello-world # scaffolds a page (https://my-project.test/hello-world)
 
 buddy --help
 ```
@@ -150,23 +157,27 @@ buddy add # adds a stack or dependency
 buddy fresh # fresh reinstall of all deps
 buddy clean # removes all deps
 
-buddy upgrade # auto-upgrades deps, framework, node.js, and/or pnpm
+buddy upgrade # upgrades all dependencies
+buddy upgrade -i # prompts you to select which updates to apply (wip)
 buddy upgrade:dependencies # auto-upgrades deps & the Stacks framework
 buddy upgrade:framework # auto-upgrades deps & the Stacks framework
-buddy upgrade:package-manager # auto-upgrades deps & the Stacks framework
 buddy upgrade:search-engine # auto-upgrades configured search engine
-buddy upgrade:node # upgrades to latest project-defined node version
-buddy upgrade:all # upgrades Node, package manager, framework, dependencies
+buddy upgrade:bun # upgrades to latest project-defined Bun version
+buddy upgrade:all # auto-upgrades all of the above
 
 # if you need any more info on any command listed here, you may suffix
 # any of them via the "help option", i.e. `buddy ... --help`
 
-buddy dev # starts one of the dev servers (components, functions, views, or docs)
-buddy dev:components # starts local playground dev server
-buddy dev:desktop # starts the Desktop playground
-buddy dev:views # starts local playground views dev server
-buddy dev:functions # stubs local the functions
+buddy dev # starts the frontend dev server
+buddy dev -i # prompts any of the dev servers (components, functions, views, or docs)
+buddy dev:api # starts the API dev server
+buddy dev:admin # starts the Admin/Dashboard dev server
+buddy dev:desktop # starts the Desktop dev server
+buddy dev:views # starts frontend dev server
+buddy dev:components # starts component dev server
+buddy dev:functions # stubs functions
 buddy dev:docs # starts local docs dev server
+buddy dev docs # also starts the local docs dev server (colon is optional)
 buddy development # `buddy dev` alias
 
 # for Laravel folks, `serve` may ring more familiar than the `dev` name. Hence, we aliased it:
@@ -205,16 +216,37 @@ buddy key:generate
 
 buddy make:component HelloWorld # bootstraps a HelloWorld component
 buddy make:function hello-world # bootstraps a hello-world function
-buddy make:page hello-world # bootstraps a hello-word page
+buddy make:view hello-world # bootstraps a hello-word page
 buddy make:model Car # bootstraps a Car model
 buddy make:database cars # creates a cars database
 buddy make:migration create_cars_table # creates a cars migration file
 buddy make:factory cars # creates a Car factory file
 buddy make:seed cars # creates a Car seed file
-buddy make:table cars # boostraps a cars data table
+buddy make:table cars # bootstraps a cars data table
 buddy make:notification welcome-email # bootstraps a welcome-email notification
 buddy make:lang de # bootstraps a lang/de.yml language file
-buddy make:stack my-project # shares logic with `npx stacks new my-project`
+buddy make:stack my-project # shares logic with `bunx stacks new my-project`
+
+buddy migrate # runs database migrations
+buddy migrate:dns # sets the ./config/dns.ts file
+
+buddy dns example.com # list all DNS records for example.com
+buddy dns example.com --type MX # list MX records for example.com (proxies dog)
+
+buddy https httpie.io/hello
+# http [flags] [METHOD] URL [ITEM [ITEM]]
+buddy http --help
+buddy http PUT pie.dev/put X-API-Token:123 name=John # Custom HTTP method, HTTP headers and JSON data
+buddy http -v pie.dev/get # See the request that is being sent using one of the output options
+buddy http -f POST pie.dev/post hello=World # submitting forms
+buddy http --offline pie.dev/post hello=offline
+buddy http -a USERNAME POST https://api.github.com/repos/httpie/cli/issues/83/comments body='HTTPie is awesome! :heart:'
+buddy http pie.dev/post < files/data.json
+buddy http pie.dev/image/png > image.png
+buddy http --download pie.dev/image/png
+buddy http --session=logged-in -a username:password pie.dev/get API-Key:123
+buddy http --session=logged-in pie.dev/headers
+buddy http localhost:8000 Host:example.com
 
 buddy lint # runs linter
 buddy lint:fix # runs linter and fixes issues
@@ -225,10 +257,15 @@ buddy changelog # generates CHANGELOG.md
 
 # when deploying your app/s to a remote server or cloud provider
 buddy deploy # select a specific deployment (follow CLI prompts)
-buddy deploy:docs # deploys docs to AWS (or other configured provider)
-buddy deploy:functions # deploys functions to AWS (or other configured provider)
-buddy deploy:views # deploys views to AWS (or other configured provider)
-buddy deploy:all # deploys all your code
+# buddy deploy:docs # deploys docs to AWS (or other configured provider)
+# buddy deploy:functions # deploys functions to AWS (or other configured provider)
+# buddy deploy:views # deploys views to AWS (or other configured provider)
+# buddy deploy:all # deploys all your code
+buddy undeploy # be careful: "undeploys" removes/deletes your deployed resources
+
+buddy cloud:remove # removes cloud setup
+buddy cloud:cleanup # removes cloud setup & cleans up all potentially leftover resources
+buddy cloud:add --jump-box # adds a jump box to your cloud setup
 
 # select the example to run (follow CLI prompts)
 buddy example # prompts you to select which example to run
@@ -252,6 +289,13 @@ buddy key:generate # generates your application key
 buddy types:generate # generates types for your components, functions, & views
 buddy types:fix # auto-fixes types for your components, functions, & views
 
+buddy domains # alias for `buddy domains:list`
+buddy domains:add stacksjs.org # adds a domain
+buddy domains:remove stacksjs.org # removes a domain
+buddy domains:list # lists all domains
+buddy domains:update # apply ./config/dns.ts updates
+buddy domains:purchase stacksjs.org # purchase a new domain
+
 # test your stack
 buddy test # runs test suite (unit & e2e)
 buddy test:coverage # runs test coverage
@@ -269,83 +313,11 @@ buddy fresh
 
 Read more here about the Stacks CLI in the documentation.
 
-## 📚 Utilizing the Built Libraries
-
-Because Stacks optimizes the development of easily reusable & composable component & function libraries, the primary intention is to always _keep it simple, yet configurable._
-
-By default, Stacks realizes whether your Stack includes components, functions, and/or views. Based on that determination, Stacks builds your outputs.
-
-The UI libraries that automatically get built are: a Web Component (Custom Elements) & Vue Component library.
-
-<details>
-<summary>Web Component usage</summary>
-
-```bash
-npm install my-awesome-library
-```
-
-After you installed your Stacks generated library, you can use a "Custom Element" (Web Component) in the following way:
-
-```html
-<html>
-  <body>
-    <hello-world name="Jane Doe"></hello-world>
-    <script src="my-awesome-library.js"></script>
-  </body>
-</html>
-```
-
-</details>
-
-<details>
-<summary>Vue 2 & 3 usage</summary>
-
-```bash
-npm install my-awesome-library
-```
-
-After you installed your Stacks generated library, you can use your Vue Components in the following way:
-
-```vue
-<script setup lang="ts">
-import HelloWorld from 'my-awesome-library'
-</script>
-
-<template>
-  <HelloWorld name="J Doe" />
-</template>
-```
-
-</details>
-
-_A function library may also be automatically generated._
-
-<details>
-<summary>Functions usage</summary>
-
-```bash
-npm install hello-world-library
-```
-
-After you installed your Stacks generated library, you can use your functions in the following way:
-
-```ts
-import { count, increment } from 'hello-world-fx'
-
-console.log('count is', count)
-increment()
-console.log('increased count is', count)
-```
-
-</details>
-
-You may view this framework as an incredibly “useful set of frames” to assist in efficiently bootstrapping, designing, and managing component & function libraries—using industry best practices, to reach one of the broadest user bases possible.
-
 ## 🎯 Roadmap
 
 Part of the Stacks ecosystem are the following first-party supported stacks:
 
-- [Table](https://github.com/stacksjs/stacks/tree/main/.stacks/stacks/tables) (Data tables with ease)
+- [Table](https://github.com/stacksjs/stacks/tree/main/storage/framework/core/stacks/tables) (Data tables with ease)
 - [Calendar](https://github.com/stacksjs/calendar) (Add to Calendar utilities—iCal, Google, and more)
 - [Command Palette](https://github.com/stacksjs/command-palette) (`⌘ + k` for the web)
 - [Date Picker](https://github.com/stacksjs/date-picker) (Beautiful, modern date picker)
@@ -353,17 +325,19 @@ Part of the Stacks ecosystem are the following first-party supported stacks:
 - [Image](https://github.com/stacksjs/image) (Modern image experience)
 - [Video](https://github.com/stacksjs/video) (Modern video experience)
 - [Audio](https://github.com/stacksjs/audio) (Modern audio experience)
-- [Identity](https://github.com/stacksjs/identity) (Identity providers & wallet integrations)
+- [Identity](https://github.com/stacksjs/identity) (Identity providers)
 - [Digital Ownership](https://github.com/stacksjs/ownership) (Public ownership protocol integrations)
-- [Payments](https://github.com/stacksjs/payments) (Unified payment APIs)
+- [Payments](https://github.com/stacksjs/payments) (Unified payment & wallet APIs)
 - [Governance](https://github.com/stacksjs/governance) (Powerful toolkit for democratic governance)
 
 View our detailed roadmap/s [here](https://github.com/stacksjs/stacks/projects?query=is%3Aopen), for more information. Additionally, you may find interesting stacks, information & examples over at [Awesome Stacks](https://github.com/stacksjs/awesome-stacks).
 
+While we currently only fully support `us-east-1`, we are looking forward to expanding to other regions soon.
+
 ## 🧪 Testing
 
 ```bash
-pnpm test
+bun test
 ```
 
 ## 📈 Changelog
@@ -382,7 +356,7 @@ For help, discussion about best practices, or any other conversation that would
 
 For casual chit-chat with others using this package:
 
-[Join the Stacks Discord Server](https://discord.ow3.org)
+[Join the Stacks Discord Server](https://discord.gg/stacksjs)
 
 ## 📄 Sponsors
 
@@ -400,7 +374,7 @@ Many thanks to the following core technologies & people who have contributed to
 
 The MIT License (MIT). Please see [LICENSE](LICENSE.md) for more information.
 
-Made with ❤️
+Made with 💙
 
 <!-- Badges -->
 [npm-version-src]: https://img.shields.io/npm/v/stacks?style=flat-square