create-atsdc-stack 1.0.0
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.
- package/.claude/settings.local.json +9 -0
- package/CONTRIBUTING.md +342 -0
- package/INSTALLATION.md +359 -0
- package/LICENSE +201 -0
- package/README.md +405 -0
- package/app/.astro/settings.json +5 -0
- package/app/.astro/types.d.ts +1 -0
- package/app/.env.example +17 -0
- package/app/README.md +251 -0
- package/app/astro.config.mjs +83 -0
- package/app/drizzle.config.ts +16 -0
- package/app/package.json +52 -0
- package/app/public/manifest.webmanifest +36 -0
- package/app/src/components/Card.astro +36 -0
- package/app/src/db/initialize.ts +107 -0
- package/app/src/db/schema.ts +72 -0
- package/app/src/db/validations.ts +158 -0
- package/app/src/env.d.ts +1 -0
- package/app/src/layouts/Layout.astro +63 -0
- package/app/src/lib/config.ts +36 -0
- package/app/src/lib/content-converter.ts +141 -0
- package/app/src/lib/dom-utils.ts +230 -0
- package/app/src/lib/exa-search.ts +269 -0
- package/app/src/pages/api/chat.ts +91 -0
- package/app/src/pages/api/posts.ts +350 -0
- package/app/src/pages/index.astro +87 -0
- package/app/src/styles/components/button.scss +152 -0
- package/app/src/styles/components/card.scss +180 -0
- package/app/src/styles/components/form.scss +240 -0
- package/app/src/styles/global.scss +141 -0
- package/app/src/styles/pages/index.scss +80 -0
- package/app/src/styles/reset.scss +83 -0
- package/app/src/styles/variables/globals.scss +96 -0
- package/app/src/styles/variables/mixins.scss +238 -0
- package/app/tsconfig.json +45 -0
- package/bin/cli.js +1138 -0
- package/package.json +37 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,405 @@
|
|
|
1
|
+
# ATSDC Stack
|
|
2
|
+
|
|
3
|
+
A production-ready, full-stack web application framework combining the best modern technologies for building secure, type-safe, and AI-ready web applications.
|
|
4
|
+
|
|
5
|
+
## 🚀 Stack Overview
|
|
6
|
+
|
|
7
|
+
The **ATSDC Stack** is a carefully curated combination of modern web technologies:
|
|
8
|
+
|
|
9
|
+
- **A** - [Astro](https://astro.build) - Lightning-fast static site generation with dynamic capabilities
|
|
10
|
+
- **T** - [TypeScript](https://www.typescriptlang.org) - Full type safety across your entire application
|
|
11
|
+
- **S** - [SCSS](https://sass-lang.com) - Powerful styling with variables, mixins, and modules
|
|
12
|
+
- **D** - [Drizzle ORM](https://orm.drizzle.team) - Type-safe database operations with PostgreSQL
|
|
13
|
+
- **C** - [Clerk](https://clerk.com) - Complete authentication and user management
|
|
14
|
+
|
|
15
|
+
### Additional Technologies
|
|
16
|
+
|
|
17
|
+
- **Zero** - Local-first sync engine for real-time data synchronization
|
|
18
|
+
- **Zod** - TypeScript-first schema validation with runtime type safety
|
|
19
|
+
- **Vercel AI SDK** - Seamless integration with AI language models
|
|
20
|
+
- **NanoID** - Secure, URL-friendly unique identifiers for database records
|
|
21
|
+
- **Vite PWA** - Progressive Web App capabilities with offline support
|
|
22
|
+
- **Cheerio** - Server-side jQuery for HTML/DOM manipulation
|
|
23
|
+
- **Marked** - Fast Markdown to HTML converter
|
|
24
|
+
- **Turndown** - HTML to Markdown converter
|
|
25
|
+
- **Exa** - AI-powered search for intelligent content discovery
|
|
26
|
+
|
|
27
|
+
## 📦 Installation
|
|
28
|
+
|
|
29
|
+
### Using NPX (Recommended)
|
|
30
|
+
|
|
31
|
+
Create a new project using the ATSDC Stack CLI:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
# Fully interactive mode - prompts for everything
|
|
35
|
+
npx create-atsdc-stack
|
|
36
|
+
|
|
37
|
+
# Provide project name, get prompted for install/setup options
|
|
38
|
+
npx create-atsdc-stack my-app
|
|
39
|
+
|
|
40
|
+
# Skip prompts with explicit flags
|
|
41
|
+
npx create-atsdc-stack my-app --install
|
|
42
|
+
npx create-atsdc-stack my-app --install --setup-db
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
The CLI will interactively prompt you for any options you don't provide:
|
|
46
|
+
|
|
47
|
+
- **Project name** - if not provided as argument
|
|
48
|
+
- **Install dependencies** - if `--install` flag not provided
|
|
49
|
+
- **Setup database** - if `--setup-db` flag not provided (only when installing)
|
|
50
|
+
- **Vercel login** - prompted after installation to enable immediate deployment
|
|
51
|
+
|
|
52
|
+
### Manual Installation
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
# Clone this repository
|
|
56
|
+
git clone https://github.com/yourusername/atsdc-stack.git my-app
|
|
57
|
+
cd my-app
|
|
58
|
+
|
|
59
|
+
# Install dependencies
|
|
60
|
+
npm install
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## ⚙️ Configuration
|
|
64
|
+
|
|
65
|
+
### 1. Environment Variables
|
|
66
|
+
|
|
67
|
+
**Note:** When using the CLI (`npx create-atsdc-stack`), the `.env` file is automatically created from `.env.example` - no manual copying needed!
|
|
68
|
+
|
|
69
|
+
If you're setting up manually, copy `.env.example` to `.env`:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
cp .env.example .env
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Required environment variables:
|
|
76
|
+
|
|
77
|
+
- `DATABASE_URL` - PostgreSQL connection string
|
|
78
|
+
- `PUBLIC_CLERK_PUBLISHABLE_KEY` - Clerk publishable key
|
|
79
|
+
- `CLERK_SECRET_KEY` - Clerk secret key
|
|
80
|
+
- `OPENAI_API_KEY` - OpenAI API key (for AI features)
|
|
81
|
+
|
|
82
|
+
### 2. Database Setup
|
|
83
|
+
|
|
84
|
+
**Note:** When using the CLI with the `--setup-db` flag, the database schema is automatically pushed for you!
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
npx create-atsdc-stack my-app --install --setup-db
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
If setting up manually or if you skipped the automatic setup, push your database schema to PostgreSQL:
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
npm run db:push
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Generate migrations (optional):
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
npm run db:generate
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### 3. Start Development Server
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
npm run dev
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
Your application will be available at `http://localhost:4321`
|
|
109
|
+
|
|
110
|
+
## 📁 Project Structure
|
|
111
|
+
|
|
112
|
+
```text
|
|
113
|
+
├── app/ # Astro application
|
|
114
|
+
│ ├── public/ # Static assets
|
|
115
|
+
│ ├── src/
|
|
116
|
+
│ │ ├── components/ # Reusable Astro components
|
|
117
|
+
│ │ ├── db/
|
|
118
|
+
│ │ │ ├── initialize.ts # Database client and initialization
|
|
119
|
+
│ │ │ ├── schema.ts # Drizzle ORM schema definitions
|
|
120
|
+
│ │ │ └── validations.ts # Zod validation schemas
|
|
121
|
+
│ │ ├── layouts/
|
|
122
|
+
│ │ │ └── Layout.astro # Base layout component
|
|
123
|
+
│ │ ├── lib/ # Utility libraries
|
|
124
|
+
│ │ │ ├── config.ts # Application configuration
|
|
125
|
+
│ │ │ ├── content-converter.ts # Markdown/HTML conversion
|
|
126
|
+
│ │ │ ├── dom-utils.ts # DOM manipulation utilities
|
|
127
|
+
│ │ │ └── exa-search.ts # AI-powered search
|
|
128
|
+
│ │ ├── pages/
|
|
129
|
+
│ │ │ ├── api/ # API routes
|
|
130
|
+
│ │ │ │ ├── chat.ts # Vercel AI SDK chat endpoint
|
|
131
|
+
│ │ │ │ └── posts.ts # CRUD operations for posts
|
|
132
|
+
│ │ │ └── index.astro # Home page
|
|
133
|
+
│ │ └── styles/
|
|
134
|
+
│ │ ├── variables/
|
|
135
|
+
│ │ │ ├── globals.scss # SCSS global variables
|
|
136
|
+
│ │ │ └── mixins.scss # SCSS mixins
|
|
137
|
+
│ │ ├── reset.scss # CSS reset
|
|
138
|
+
│ │ ├── global.scss # Global styles
|
|
139
|
+
│ │ ├── components/ # Component-specific styles
|
|
140
|
+
│ │ └── pages/ # Page-specific styles
|
|
141
|
+
│ ├── astro.config.mjs # Astro configuration
|
|
142
|
+
│ ├── drizzle.config.ts # Drizzle ORM configuration
|
|
143
|
+
│ ├── package.json # App dependencies
|
|
144
|
+
│ └── tsconfig.json # TypeScript configuration
|
|
145
|
+
├── bin/
|
|
146
|
+
│ └── cli.js # CLI entry point for scaffolding
|
|
147
|
+
└── package.json # Root workspace configuration
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
## 🎨 SCSS Architecture
|
|
151
|
+
|
|
152
|
+
This stack enforces a strict separation of concerns for styling with **semantic, readable class names** - no utility classes like Tailwind.
|
|
153
|
+
|
|
154
|
+
### Rules
|
|
155
|
+
|
|
156
|
+
1. **Semantic class names** - Use readable, meaningful class names (e.g., `.btn`, `.card`, `.header`) instead of utility classes (e.g., `.px-4`, `.bg-blue-500`)
|
|
157
|
+
2. **No inline `<style>` tags** in `.astro` files (except for truly standalone components)
|
|
158
|
+
3. **All styles in external SCSS files** for better maintainability and smaller CSS footprint
|
|
159
|
+
4. **Component-specific styles** in `app/src/styles/components/`
|
|
160
|
+
5. **Page-specific styles** in `app/src/styles/pages/`
|
|
161
|
+
6. **Use data attributes for modifiers** (preferred over BEM modifier classes)
|
|
162
|
+
7. **Use class chaining** when data attributes aren't appropriate
|
|
163
|
+
|
|
164
|
+
### Example Usage
|
|
165
|
+
|
|
166
|
+
```astro
|
|
167
|
+
---
|
|
168
|
+
// src/pages/example.astro
|
|
169
|
+
import Layout from '@/layouts/Layout.astro';
|
|
170
|
+
import '@/styles/components/button.scss';
|
|
171
|
+
import '@/styles/pages/example.scss';
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
<Layout pageTitle="Example Page">
|
|
175
|
+
<div class="example-page">
|
|
176
|
+
<h1>Hello World</h1>
|
|
177
|
+
<!-- Preferred: Data attributes for modifiers -->
|
|
178
|
+
<button class="btn" data-variant="primary" data-size="lg">Click Me</button>
|
|
179
|
+
|
|
180
|
+
<!-- Alternative: Class chaining -->
|
|
181
|
+
<button class="btn primary lg">Click Me Too</button>
|
|
182
|
+
</div>
|
|
183
|
+
</Layout>
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
### Styling Approach
|
|
187
|
+
|
|
188
|
+
#### Preferred: Data Attributes
|
|
189
|
+
|
|
190
|
+
```scss
|
|
191
|
+
.btn {
|
|
192
|
+
@include button-base;
|
|
193
|
+
|
|
194
|
+
&[data-variant='primary'] { /* styles */ }
|
|
195
|
+
&[data-size='lg'] { /* styles */ }
|
|
196
|
+
&[data-state='loading'] { /* styles */ }
|
|
197
|
+
}
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
#### Alternative: Class Chaining
|
|
201
|
+
|
|
202
|
+
```scss
|
|
203
|
+
.btn {
|
|
204
|
+
@include button-base;
|
|
205
|
+
|
|
206
|
+
&.primary { /* styles */ }
|
|
207
|
+
&.lg { /* styles */ }
|
|
208
|
+
&.loading { /* styles */ }
|
|
209
|
+
}
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### Available Mixins
|
|
213
|
+
|
|
214
|
+
The stack provides readable, semantic mixins instead of cryptic utility names:
|
|
215
|
+
|
|
216
|
+
```scss
|
|
217
|
+
@import '@/styles/mixins';
|
|
218
|
+
|
|
219
|
+
.my-component {
|
|
220
|
+
@include flex-center; // Center content with flexbox
|
|
221
|
+
@include card; // Card styling
|
|
222
|
+
@include button-primary; // Primary button styles
|
|
223
|
+
@include heading-1; // H1 typography
|
|
224
|
+
}
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### SCSS Variables
|
|
228
|
+
|
|
229
|
+
Use descriptive variable names that clearly indicate their purpose:
|
|
230
|
+
|
|
231
|
+
```scss
|
|
232
|
+
// ✅ Good: Readable, semantic names
|
|
233
|
+
$color-primary: #007bff;
|
|
234
|
+
$spacing-large: 2rem;
|
|
235
|
+
$border-radius-default: 0.5rem;
|
|
236
|
+
$font-size-heading: 2rem;
|
|
237
|
+
|
|
238
|
+
// ❌ Avoid: Cryptic abbreviations
|
|
239
|
+
$clr-1: #007bff;
|
|
240
|
+
$sp-lg: 2rem;
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
## 🗄️ Database Operations
|
|
244
|
+
|
|
245
|
+
### Schema Definition
|
|
246
|
+
|
|
247
|
+
Define your database schema using Drizzle ORM with NanoID:
|
|
248
|
+
|
|
249
|
+
```typescript
|
|
250
|
+
// src/db/schema.ts
|
|
251
|
+
import { pgTable, text, varchar } from 'drizzle-orm/pg-core';
|
|
252
|
+
import { nanoid } from 'nanoid';
|
|
253
|
+
|
|
254
|
+
export const posts = pgTable('posts', {
|
|
255
|
+
id: varchar('id', { length: 21 })
|
|
256
|
+
.primaryKey()
|
|
257
|
+
.$defaultFn(() => nanoid()),
|
|
258
|
+
title: varchar('title', { length: 255 }).notNull(),
|
|
259
|
+
content: text('content').notNull(),
|
|
260
|
+
});
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
### Validation with Zod
|
|
264
|
+
|
|
265
|
+
Create Zod schemas for runtime validation:
|
|
266
|
+
|
|
267
|
+
```typescript
|
|
268
|
+
// src/db/validations.ts
|
|
269
|
+
import { z } from 'zod';
|
|
270
|
+
|
|
271
|
+
export const createPostSchema = z.object({
|
|
272
|
+
title: z.string().min(1).max(255),
|
|
273
|
+
content: z.string().min(1),
|
|
274
|
+
});
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
### API Routes
|
|
278
|
+
|
|
279
|
+
Create type-safe API routes:
|
|
280
|
+
|
|
281
|
+
```typescript
|
|
282
|
+
// src/pages/api/posts.ts
|
|
283
|
+
import type { APIRoute } from 'astro';
|
|
284
|
+
import { db } from '@/db/initialize';
|
|
285
|
+
import { posts } from '@/db/schema';
|
|
286
|
+
import { createPostSchema } from '@/db/validations';
|
|
287
|
+
|
|
288
|
+
export const POST: APIRoute = async ({ request }) => {
|
|
289
|
+
const body = await request.json();
|
|
290
|
+
const validated = createPostSchema.parse(body);
|
|
291
|
+
|
|
292
|
+
const [newPost] = await db
|
|
293
|
+
.insert(posts)
|
|
294
|
+
.values(validated)
|
|
295
|
+
.returning();
|
|
296
|
+
|
|
297
|
+
return new Response(JSON.stringify(newPost), { status: 201 });
|
|
298
|
+
};
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
## 🤖 AI Integration
|
|
302
|
+
|
|
303
|
+
The stack includes Vercel AI SDK with AI Gateway for seamless AI integration - no provider-specific packages needed!
|
|
304
|
+
|
|
305
|
+
**Note:** AI Gateway requires Vercel AI SDK v5.0.0 or later (already configured in this stack).
|
|
306
|
+
|
|
307
|
+
```typescript
|
|
308
|
+
// src/pages/api/chat.ts
|
|
309
|
+
import type { APIRoute } from 'astro';
|
|
310
|
+
import { streamText } from 'ai';
|
|
311
|
+
|
|
312
|
+
export const POST: APIRoute = async ({ request }) => {
|
|
313
|
+
const { messages } = await request.json();
|
|
314
|
+
|
|
315
|
+
const result = streamText({
|
|
316
|
+
model: 'openai/gpt-4o', // Use model string directly - supports any provider
|
|
317
|
+
messages,
|
|
318
|
+
apiKey: process.env.OPENAI_API_KEY,
|
|
319
|
+
});
|
|
320
|
+
|
|
321
|
+
return result.toDataStreamResponse();
|
|
322
|
+
};
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
**Supported model formats:**
|
|
326
|
+
|
|
327
|
+
- OpenAI: `openai/gpt-4.1`, `openai/o4-mini`
|
|
328
|
+
- Anthropic: `anthropic/claude-3-5-sonnet-20241022`
|
|
329
|
+
- Google: `google/gemini-1.5-pro`
|
|
330
|
+
- And many more providers without extra dependencies!
|
|
331
|
+
|
|
332
|
+
## 🔐 Authentication
|
|
333
|
+
|
|
334
|
+
Clerk is pre-configured for authentication. Protect routes with middleware:
|
|
335
|
+
|
|
336
|
+
```typescript
|
|
337
|
+
// src/middleware.ts
|
|
338
|
+
import { clerkMiddleware } from '@clerk/astro/server';
|
|
339
|
+
|
|
340
|
+
export const onRequest = clerkMiddleware();
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
## 🚀 Deployment
|
|
344
|
+
|
|
345
|
+
### Vercel (Recommended)
|
|
346
|
+
|
|
347
|
+
The Vercel CLI is already included in the project! If you used the CLI setup, you may already be logged in.
|
|
348
|
+
|
|
349
|
+
```bash
|
|
350
|
+
# Login to Vercel (if not already logged in)
|
|
351
|
+
npx vercel login
|
|
352
|
+
|
|
353
|
+
# Deploy to production
|
|
354
|
+
npx vercel --prod
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
### Environment Variables on Vercel
|
|
358
|
+
|
|
359
|
+
Set these in your Vercel project settings:
|
|
360
|
+
|
|
361
|
+
- `DATABASE_URL`
|
|
362
|
+
- `CLERK_SECRET_KEY`
|
|
363
|
+
- `OPENAI_API_KEY`
|
|
364
|
+
|
|
365
|
+
## 📚 Documentation
|
|
366
|
+
|
|
367
|
+
- [Astro Documentation](https://docs.astro.build)
|
|
368
|
+
- [Drizzle ORM Documentation](https://orm.drizzle.team/docs)
|
|
369
|
+
- [Clerk Documentation](https://clerk.com/docs)
|
|
370
|
+
- [Zero Sync Documentation](https://zero.rocicorp.dev)
|
|
371
|
+
- [Zod Documentation](https://zod.dev)
|
|
372
|
+
- [Vercel AI SDK Documentation](https://sdk.vercel.ai/docs)
|
|
373
|
+
|
|
374
|
+
## 🛠️ Available Scripts
|
|
375
|
+
|
|
376
|
+
```bash
|
|
377
|
+
npm run dev # Start development server
|
|
378
|
+
npm run build # Build for production
|
|
379
|
+
npm run preview # Preview production build
|
|
380
|
+
npm run db:generate # Generate database migrations
|
|
381
|
+
npm run db:migrate # Run database migrations
|
|
382
|
+
npm run db:push # Push schema to database
|
|
383
|
+
npm run db:studio # Open Drizzle Studio
|
|
384
|
+
```
|
|
385
|
+
|
|
386
|
+
## 📄 License
|
|
387
|
+
|
|
388
|
+
MIT License - see LICENSE file for details
|
|
389
|
+
|
|
390
|
+
## 🤝 Contributing
|
|
391
|
+
|
|
392
|
+
Contributions are welcome! Please open an issue or submit a pull request.
|
|
393
|
+
|
|
394
|
+
## 💡 Why This Stack?
|
|
395
|
+
|
|
396
|
+
1. **Type Safety** - TypeScript + Drizzle + Zod ensure type safety from database to frontend
|
|
397
|
+
2. **Performance** - Astro's zero-JS by default approach for maximum performance
|
|
398
|
+
3. **Real-time Sync** - Zero provides local-first data synchronization for responsive UIs
|
|
399
|
+
4. **Developer Experience** - Modern tooling with excellent IDE support and automated setup
|
|
400
|
+
5. **Scalability** - PostgreSQL + serverless architecture scales effortlessly
|
|
401
|
+
6. **Security** - Clerk handles authentication, Zod validates inputs
|
|
402
|
+
7. **AI-Ready** - Vercel AI SDK integration for modern AI features
|
|
403
|
+
8. **PWA Support** - Offline-first capabilities with Vite PWA
|
|
404
|
+
9. **Clean Architecture** - Enforced separation of concerns, especially for styles
|
|
405
|
+
10. **Quick Start** - Automated environment setup and database initialization
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
/// <reference types="astro/client" />
|
package/app/.env.example
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Database
|
|
2
|
+
DATABASE_URL="postgresql://user:password@localhost:5432/dbname"
|
|
3
|
+
|
|
4
|
+
# Clerk Authentication
|
|
5
|
+
PUBLIC_CLERK_PUBLISHABLE_KEY="pk_test_..."
|
|
6
|
+
CLERK_SECRET_KEY="sk_test_..."
|
|
7
|
+
|
|
8
|
+
# OpenAI and other AI model providers (for Vercel AI SDK)
|
|
9
|
+
OPENAI_API_KEY="sk-..."
|
|
10
|
+
|
|
11
|
+
# Exa Search (for AI-powered search)
|
|
12
|
+
EXA_API_KEY="..."
|
|
13
|
+
|
|
14
|
+
# Vercel (for deployment)
|
|
15
|
+
# These are automatically set by Vercel
|
|
16
|
+
# VERCEL_URL
|
|
17
|
+
# VERCEL_ENV
|