Skip to content

Commit 4345598

Browse files
committed
chore: wip
1 parent d74dd07 commit 4345598

File tree

3 files changed

+107
-0
lines changed

3 files changed

+107
-0
lines changed

docs/bootcamp/intro.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Bootcamp
2+
3+
This bootcamp is a collection of tutorials, guides, and resources to help you get started with Stacks. Read along to learn about the features that make up the core Stacks logic.
4+
5+
## Features
6+
7+
The Stacks framework is a harmony of several “engines”, designed to build any web and/or desktop application—in highly scalable & privacy-friendly ways. It consists of the following engines:
8+
9+
### Stacks UI
10+
11+
_Develop dynamic UIs with helpers for atomic design, and much more._
12+
13+
- 🧩 **Components** _a primitive to develop user interfaces_
14+
- 🤖 **Functions** _a primitive to develop business logic (and grant your UI superpowers)_
15+
- 🌐 **Web** _"a routing & templating engine that makes sense" using components—SSG & PWA ready_
16+
- 🖥️ **Desktop** _automagically build a desktop app out of your web app_
17+
- 📚 **Library** _auto-builds component & function libraries_
18+
- ⚡️ Powered by Bun, Nitro, Tauri, UnoCSS, Vite & Vue
19+
20+
### Stacks Functions
21+
22+
_Develop serverless (or server) functions with countless helpers to build scalable & fast APIs._
23+
24+
- 🪄 **AI** _deep AI integration_
25+
- 🤖 **APIs** _scalability & maintainability built-in_
26+
- 🏎️ **Cache** _Redis, DynamoDB, Upstash, SingleStore, and more—serverless_
27+
- ⚙️ **CLIs** _create beautiful CLIs for Linux, Windows, and Mac—without requirements_
28+
- 📀 **Database** _MySQL, Postgres, PlanetScale, Supabase, Prisma, ..._
29+
- 👾 **Errors** _native type-safe error handling_
30+
- 🗓️ **Events** _functional event (front & backend) communication_
31+
- 📢 **Notifications** _emails, SMSs, direct, and push notifications & webhooks_
32+
- 🗺️ **ORM** _supercharged, fully-typed models & relations (including automated migrations)_
33+
- 💳 **Payments** _unified API for one-off & subscription billing methods for Stripe_
34+
- ⚙️ **Queues** _run any heavy workload in the background_
35+
- 🛠️ **Query Builder** _powerful, type-safe SQL query builder_
36+
- 💬 **Realtime** _“everything you need to build dynamic real-time apps”_
37+
- 🧭 **Router** _smart routing, file-based or Laravel-like_
38+
- 🔎 **Search Engine** _smart searching, advanced filtering & sorting, pagination, headless UI_
39+
- 💾 **Storage** _easily create & make use of local & remote storages/file systems_
40+
- 🧪 **Tinker** _a powerful TypeScript REPL_
41+
- 🌪️ **Validation** _e2e type-safety (true frontend & backend harmony)_
42+
- 🎯 **X-Ray** _all you need to debug, log & analyze_
43+
44+
### Stacks Cloud
45+
46+
_Create your personal or professional Vercel-like cloud, based on MIT-licensed OSS._
47+
48+
- ☁️ **Server** _local development server & production-ready servers_
49+
- ⛅️ **Serverless** _on-demand, auto-scaling, zero maintenance_
50+
- 🚏 **CDN** _zero-config low-latency CDN, including request life-cycle hooks & optimized request compressions (Brotli & gzip)_
51+
- 🔀 **Domain** _version-controlled & zero-config domain management (e.g. DNS management)_
52+
- 📧 **Email** _secure & simplistic <easy-peasy@custom-domains.com> mail_
53+
- 🔐 **Firewall** _native web application firewall support_
54+
- 🚜 **Maintenance** _maintain your cloud infrastructure with ease using Buddy & Stacks_
55+
- 🤖 **Infrastructure as Code** _version-controlled cloud infrastructure_
56+
57+
### Stacks CI/CD
58+
59+
_Focus on coding, not publishing._
60+
61+
- 🚀 **Deployment Manager** _take the sweat out of production deployments (AWS, Vercel, Netlify, and more)_
62+
- 📫 **Release Manager** _libraries (component & function) auto-published to npm, git helpers, and more_
63+
64+
### Stacks DX
65+
66+
_Enhanced productivity for developers. No more creating boilerplate._
67+
68+
- 💡 **IDE Integration** _auto-completions, inline docs & a powerful VS Code setup_
69+
- 🪄 **Zero-Config** _yet highly configurable—convention over configuration_
70+
- 👩🏽‍🔧 **Linter & Formatter** _auto-configured & built into your IDE_
71+
- 💪🏼 **Type Strong** _built-in e2e type-safety_
72+
-**Git Workflows** _committing with ease_
73+
- 🚗 **Auto Imports** _your components & functions, including date, string, array, & object helpers_
74+
-**Code Snippets** _say goodbye to the boilerplate—thank you Sarah Drasner_
75+
- 🔤 **Spell Checker** _be notified once there are typos_
76+
- 🛠️ **Utilities** _Collections, VueUse, and more_
77+
- 🧪 **Testing** _unit & e2e tests powered by Bun & Playwright_
78+
79+
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.
80+
81+
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 ✌🏼_
82+
83+
Continue with this bootcamp to learn about the above.

docs/guide/getting-started.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,12 @@
11
# Getting Started
2+
3+
It's incredibly easy to get started with this framework. Simply run the following command in your terminal:
4+
5+
```bash
6+
# not working atm
7+
sh <(curl stacksjs.org) my-project
8+
9+
# alternatively, if Bun >= v1.0 is installed already,
10+
# you may also get started via:
11+
bunx stacks new my-project
12+
```

docs/guide/what-is-stacks.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,14 @@
11
# What is Stacks?
2+
3+
Stacks is a rapid application & library development framework for TypeScript. The goal of the framework is to help you create & maintain frontends, backends, and clouds—without having to worry about the boilerplate.
4+
5+
- Web & Desktop applications
6+
- Serverless & traditional APIs
7+
- Cloud infrastructure creation & maintenance
8+
- Interactive CLIs
9+
- Framework-agnostic component & function libraries
10+
- Deployment & Release Manager _(CI & CD)_
11+
12+
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.
13+
14+
> “Convention over configuration” is the Stacks mantra. _- Chris_

0 commit comments

Comments
 (0)