npm - @stacksjs/buddy - Versions diffs - 0.59.6 → 0.59.8 - Mend

@stacksjs/buddy 0.59.6 → 0.59.8

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 (3) hide show

package/README.md CHANGED Viewed

@@ -1,4 +1,4 @@
-![Social Card of Stacks](./art/social.jpg)
+![Social Card of Stacks](../../../../public/social.jpg)
 # Rapid App & Library Development
@@ -8,138 +8,64 @@
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
 <!-- [![Codecov][codecov-src]][codecov-href] -->
-_Open Beta coming soon._
+> [!WARNING]
+> Stay tuned. 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 development framework, meeting all your full stack needs.
+Stacks is a rapid development framework, where the goal is to _help you_ create & maintain frontends, backends, and clouds—without having to worry about the boilerplate. _An all-in-one toolkit that meets all your full stack needs._
-- Web & Desktop applications
-- Serverless & traditional APIs
-- Cloud infrastructure creation & maintenance
+- Web & Desktop Applications _(including system tray apps)_
+- Serverless & Traditional APIs
+- Cloud Infrastructure Creation & Maintenance
 - Interactive CLIs
-- Framework-agnostic component & function libraries
+- Framework-agnostic Component & Function Libraries
 - Deployment & Release Manager _(CI & CD)_
-Stacks helps you every step along the way—in beginner & expert-friendly ways, allowing you to focus on the _what_ and _why_ of your project.
+In other words, Stacks helps you, as a developer, every step along the way—in beginner & expert-friendly ways, allowing you to focus on the _what & why_ of your project, all while enabling you to always stay in control & ownership of your _(& your user’s)_ data.
 > “Convention over configuration” is the Stacks mantra. _- Chris_
 <!-- ![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 Frontend
-_Develop dynamic UIs with helpers for atomic design, and much more._
-- 🧩 **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 Bun, Nitro, Tauri, UnoCSS, Vite & Vue
-### Stacks Backend
-_Develop serverless (or server) functions with countless helpers to build scalable & fast APIs._
-- 🪄 **AI** _deep AI integrations & foundational model access_
-- 🤖 **APIs** _scalability & maintainability built-in_
-- 🏎️ **Cache** _Redis, DynamoDB, and more—serverless_
-- ⚙️ **CLIs** _create beautiful CLIs for Linux, Windows, and Mac—without requirements_
-- 📀 **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_
-- 🗺️ **ORM** _supercharged, fully-typed models & relations (including automated migrations)_
-- 💳 **Payments** _unified API for one-off & subscription billing methods for Stripe_
-- ⚙️ **Queues** _run any heavy workload in the background_
-- 🛠️ **Query Builder** _powerful, type-safe SQL query builder_
-- 💬 **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** _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_
-### Stacks Cloud
-_Create your personal or professional Vercel-like cloud, based on MIT-licensed OSS._
-- ☁️ **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 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_
-- 📦 **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, Google next?)_
-- 📫 **Release Manager** _libraries (component & function) auto-published to npm, git helpers, and more_
-### Stacks DX
-_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_
-- 💪🏼 **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_
-- 👥 **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.
-Develop beautiful, reactive, composable UIs without learning a new set of languages. HTML, CSS, and minimal JavaScript—that's all you need to dive in now! _Or TypeScript ✌🏼_
-> _A true rapid application development framework for all Full Stack needs. Next-level simplicity & helpful DX._
 ## Get Started
-It's incredibly easy to get started with this framework. Simply run the following command in your terminal:
+It’s incredibly easy to get started with this framework. Simply run the following command in your terminal:
 ```bash
-curl -Ssf stacksjs.org | sh # wip
+curl -Ssf stacksjs.org/install | sh # wip
-# alternatively, if Bun >= v1.0 is installed already,
+# alternatively, if Bun >= v1.0.30 is installed already,
 # you may also get started via:
 bunx stacks new my-project
 ```
-## 🤖 Usage
+## Usage
 The following list includes some of the most common ways to interact with the Stacks API.
-Meet the toolkit, Buddy:
+_Meet the toolkit, Buddy:_
 ```bash
 buddy install # installs all dependencies
-buddy dev # starts one of the dev servers (components, functions, views, or docs)
+buddy dev # starts one of the dev servers (frontend, API, components, docs, desktop, etc.)
+buddy share # creates a sharable link of your local project
 buddy build # follow CLI prompts to select which library (or server) to build
 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:view hello-world # scaffolds a page (https://my-project.test/hello-world)
+buddy make:component HelloWorld # scaffolds a Component
+buddy make:function HelloWorld # scaffolds a Function
+buddy make:model Car # scaffolds a Model
+buddy make:action UpdateCar # scaffolds an Action
+buddy make:migration create_cars_table # scaffolds a Migration
+buddy make:view Car # scaffolds a Page (https://my-project.test/car)
+buddy make:command Inspire # scaffolds a Command
+buddy make:job SendEmail # scaffolds a Job
+buddy make:middleware Logger # scaffolds a new Middleware
+buddy make:notification WelcomeEmail # scaffolds a Notification
+buddy make:lang de # scaffolds a language file
+buddy list # lists all available commands
 buddy --help
 ```
@@ -156,12 +82,16 @@ buddy install # installs dependencies
 buddy add # adds a stack or dependency
 buddy fresh # fresh reinstall of all deps
 buddy clean # removes all deps
+buddy setup # sets up the project initially
+buddy setup:oh-my-zsh # optional: sets up Oh My Zsh with auto-completions & "aliases"
 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:dependencies # auto-upgrades package.json deps
 buddy upgrade:framework # auto-upgrades deps & the Stacks framework
 buddy upgrade:search-engine # auto-upgrades configured search engine
+buddy upgrade:shell # upgrades the shell integration
+buddy upgrade:binary # upgrades the `stacks` binary
 buddy upgrade:bun # upgrades to latest project-defined Bun version
 buddy upgrade:all # auto-upgrades all of the above
@@ -169,7 +99,7 @@ buddy upgrade:all # auto-upgrades all of the above
 # any of them via the "help option", i.e. `buddy ... --help`
 buddy dev # starts the frontend dev server
-buddy dev -i # prompts any of the dev servers (components, functions, views, or docs)
+buddy dev -i # prompts any of the dev servers (components, functions, views, docs, or api)
 buddy dev:api # starts the API dev server
 buddy dev:dashboard # starts the Admin/Dashboard dev server
 buddy dev:desktop # starts the Desktop dev server
@@ -177,9 +107,11 @@ 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 dev docs # also starts the local docs dev server (colon is optional for all commands)
 buddy development # `buddy dev` alias
+buddy share # creates a sharable link to your local project
 # for Laravel folks, `serve` may ring more familiar than the `dev` name. Hence, we aliased it:
 buddy serve
 buddy serve:components
@@ -272,8 +204,9 @@ buddy example # prompts you to select which example to run
 buddy example:vue # runs the Vue example
 buddy example:web-components # runs the Web Component example
-# you likely won't need to run these commands as they are auto-triggered, but they are available
+# you likely won’t need to run these commands as they are auto-triggered, but they are available
 buddy generate  # prompts you to select which generator to run
+buddy generate:types # generates types for your components, functions, & views
 buddy generate:entries # generates entry files for components, functions, & views
 buddy generate:web-types # generates Web Component types
 buddy generate:vscode-custom-data # generates VSCode custom data
@@ -305,49 +238,116 @@ buddy test:types # runs typecheck
 stx fresh
 buddy fresh
 bud fresh
-buddy fresh
 ```
 </details>
 Read more here about the Stacks CLI in the documentation.
-## 🎯 Roadmap
+## Features
-Part of the Stacks ecosystem are the following first-party supported stacks:
+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:
-- [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)
-- [File Manager](https://github.com/stacksjs/file-manager) (Build your own file manager—like Dropbox or Google Drive)
-- [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)
-- [Digital Ownership](https://github.com/stacksjs/ownership) (Public ownership protocol integrations)
-- [Payments](https://github.com/stacksjs/payments) (Unified payment & wallet APIs)
-- [Governance](https://github.com/stacksjs/governance) (Powerful toolkit for democratic governance)
+### Frontend Development
-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).
+_Develop dynamic UIs with helpers for atomic design, and much more._
-While we currently only fully support `us-east-1`, we are looking forward to expanding to other regions soon.
+- 🧩 **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** _transforms your web app into a desktop app, plus more_
+- 📝 **Documentation** _markdown-based documentation, auto-generated_
+- 📚 **Library** _auto-builds & manages component & function libraries_
+- ⚡️ Powered by Bun, Nitro, Tauri, UnoCSS, Vite & Vue
+### Backend Development
-## 🧪 Testing
+_Develop serverless (or server) functions with countless helpers to build scalable & fast APIs._
+- 🪄 **AI** _deep AI integrations & foundational model access_
+- 🤖 **APIs** _scalability & maintainability built-in_
+- 🏎️ **Cache** _Redis, DynamoDB, and more—serverless_
+- ⚙️ **CLIs** _create beautiful CLIs for Linux, Windows, and Mac (dependency-free binaries)_
+- 📀 **Database** _SQLite, MySQL, Postgres, and more_
+- 👾 **Errors** _native type-safe error handling_
+- 🗓️ **Events** _functional event (front & backend) communication_
+- 📢 **Notifications** _emails, SMSs, direct, and push notifications & webhooks_
+- 🗺️ **ORM** _supercharged, fully-typed models & relations (including automated migrations)_
+- 💳 **Payments** _unified API for one-off & subscription billing methods for Stripe_
+- ⚙️ **Queues** _run any heavy workload in the background_
+- 🛠️ **Query Builder** _powerful, type-safe SQL query builder_
+- 💬 **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** _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_
+### Cloud Development
+_Develop & maintain cloud infrastructure with ease. “Imagine Vercel, Vapor and Forge having been unified.”_
+- ☁️ **Server** _local development server & production-ready servers out-of-the-box_
+- ⛅️ **Serverless** _on-demand, auto-scaling, zero maintenance_
+- ⏰ **Alarms** _built-in cloud infrastructure monitoring to avoid surprises_
+- 🚏 **CDN** _zero-config, low-latency, 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 & zero-setup <easy-peasy@custom-domains.com> mailboxes_
+- 🔐 **Firewall** _native web application firewall support_
+- 📦 **Storage** _unlimited cloud storage & automatic backups_
+- 🚜 **Maintenance** _maintain your cloud infrastructure with ease using Buddy & Stacks_
+- 🚦 **Infrastructure as Code** _version-controlled cloud infrastructure (AWS, Google next?)_
+### CI/CD
+_Focus on coding, not publishing._
+- 🚀 **Deployment Manager** _takes the sweat out of production deployments—zero-setup push-to-deploy_
+- 0️⃣ **Zero Downtime** _deploy with confidence using a zero-downtime deployment strategy_
+- 📫 **Release Manager** _libraries (component & function) auto-published to npm, git helpers, and more_
+### Developer Experience (DX)
+Convention over configuration, while staying wholly configurable. _No more boilerplate._
+- 💎 **Automated Upgrades** _no need to worry about upgrading to the latest versions, Stacks upgrades you_
+- 🦋 **Pretty Dev URLs** _your-project.localhost instead of localhost:3000_
+- 💡 **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_
+- 💪🏼 **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** _goodbye to the boilerplate code—thank you Sarah Drasner_
+- 🔤 **Spell Checker** _be notified once there are typos_
+- 🛠️ **Essential Utilities** _powers at your fingertips. Collections, VueUse, and more_
+- 👥 **Team Management** _manage your team & their permissions_
+- 🧪 **Streamlined Testing** _unit & e2e tests powered by Bun, Vitest & 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.
+Develop beautiful, reactive, composable UIs without learning a new set of languages. HTML, CSS, and minimal JavaScript—that’s all you need to dive in now! _Or TypeScript ✌🏼_
+> _An actual rapid application development framework for all Full Stack needs. Next-level simplicity & DX._
+## Testing
 ```bash
-bun test
+./buddy test
 ```
-## 📈 Changelog
+## Changelog
 Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
-## 🚜 Contributing
+## Contributing
 Please see the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
-## 🏝 Community
+## Community
 For help, discussion about best practices, or any other conversation that would benefit from being searchable:
@@ -357,19 +357,27 @@ For casual chit-chat with others using this package:
 [Join the Stacks Discord Server](https://discord.gg/stacksjs)
-## 📄 Sponsors
+## Postcardware
-Once we launch a usable Stacks version, we hope people will start enjoying it! Coming soon.
+Two things are true: Stacks OSS will always stay open-source, and we do/would love to receive postcards from wherever Stacks is used! 🌍 _And we also publish them on our website. -Thank you, Spatie_
-## 🙏🏼 Credits
+Our address: Stacks.js, 5710 Crescent Park #107, Playa Vista 90094, CA, USA
-Many thanks to the following core technologies & people who have contributed to this package:
+## Sponsors
+We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.
+- [JetBrains](https://www.jetbrains.com/)
+- [The Solana Foundation](https://solana.com/)
+## Credits
 - [Chris Breuer](https://github.com/chrisbbreuer)
-- [Dan Scanlon](https://twitter.com/danscan) _many thanks for donating the `stacks` name on npm_
 - [All Contributors](../../contributors)
-## 📄 License
+And a special thanks to [Dan Scanlon](https://twitter.com/danscan) for donating the `stacks` name on npm ✨
+## License
 The MIT License (MIT). Please see [LICENSE](LICENSE.md) for more information.

package/dist/stacks CHANGED Viewed

Binary file

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/buddy",
   "type": "module",
-  "version": "0.59.6",
+  "version": "0.59.8",
   "description": "Meet Buddy. The Stacks runtime.",
   "author": "Chris Breuer",
   "license": "MIT",