Skip to content

Commit 3b726de

Browse files
docs: update README for Astro 6 and Cloudflare Workers migration
- Astro 5 → 6, Cloudflare Pages → Workers - Node.js requirement v18 → v22.12.0 - Add deployment section (GitHub Actions + manual) - Update project structure with new directories
1 parent 3988078 commit 3b726de

1 file changed

Lines changed: 23 additions & 6 deletions

File tree

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ Welcome to the official repository for the **Solana Colombia** website. This pla
44

55
## 🚀 Tech Stack
66

7-
- **Framework:** [Astro 5](https://astro.build/) (Static Site Generation & Server-side Rendering)
7+
- **Framework:** [Astro 6](https://astro.build/) (Server-side Rendering)
88
- **Styling:** [Tailwind CSS 4](https://tailwindcss.com/)
99
- **Database:** [Cloudflare D1](https://developers.cloudflare.com/d1/) (SQL database for builders/profiles)
10-
- **Deployment:** [Cloudflare Pages](https://pages.cloudflare.com/)
10+
- **Deployment:** [Cloudflare Workers](https://workers.cloudflare.com/) via GitHub Actions
1111
- **Email:** [Resend](https://resend.com/)
1212
- **Blockchain:** [Solana Web3.js](https://solana-labs.github.io/solana-web3.js/) & Wallet Adapter
1313

@@ -17,7 +17,7 @@ Welcome to the official repository for the **Solana Colombia** website. This pla
1717

1818
### Prerequisites
1919

20-
- **Node.js:** `v18.20.8` or higher (Check `.nvmrc`)
20+
- **Node.js:** `v22.12.0` or higher
2121
- **npm:** Package manager included with Node.js
2222

2323
### Installation
@@ -44,14 +44,27 @@ To start the local development server:
4444
npm run dev
4545
```
4646

47-
> **Note:** The `dev` script automatically runs `npm run db:pull` to sync your local D1 database with the production data before starting the Astro server.
47+
> **Note:** The `dev` script automatically runs `npm run db:pull` to sync your local D1 database with the production data before starting the Astro dev server (runs on the real Cloudflare workerd runtime).
48+
49+
### Deployment
50+
51+
Pushing to `main` triggers automatic deployment to Cloudflare Workers via GitHub Actions. The workflow requires two repository secrets:
52+
53+
- `CLOUDFLARE_API_TOKEN`
54+
- `CLOUDFLARE_ACCOUNT_ID`
55+
56+
You can also deploy manually:
57+
58+
```sh
59+
npm run deploy
60+
```
4861

4962
### AI-assisted development (Claude Code)
5063

5164
This repo ships a set of [Claude Code hooks](docs/CLAUDE_HOOKS.md) that guard against common footguns when Claude Code is editing files or running commands:
5265

5366
- **Protected files:** `.env`, `wrangler.toml`, `schema.sql`, and already-applied `migrations/*.sql` cannot be edited by the AI.
54-
- **Blocked commands:** `wrangler pages deploy`, `wrangler d1 execute --remote`, `wrangler secret put/delete`, `DROP TABLE`, and other irreversible prod operations are refused before execution.
67+
- **Blocked commands:** `wrangler deploy`, `wrangler d1 execute --remote`, `wrangler secret put/delete`, `DROP TABLE`, and other irreversible prod operations are refused before execution.
5568
- **Auto-format + typecheck:** every `.astro`/`.ts` edit is run through `prettier` and `astro check`.
5669
- **Pre-PR gate:** `gh pr create` is blocked unless `astro check` and `astro build` both pass.
5770

@@ -146,15 +159,19 @@ The site uses Cloudflare D1 for dynamic data like the Builders directory.
146159

147160
```text
148161
/
162+
├── .github/workflows/ # GitHub Actions (auto-deploy to Workers)
149163
├── public/ # Static assets (images, icons, etc.)
164+
├── scripts/security/ # Dependency audit tooling
150165
├── src/
151166
│ ├── components/ # Reusable UI components
152167
│ ├── content/ # Content Collections (Blog, Team, Gallery)
153168
│ ├── layouts/ # Page layouts
169+
│ ├── lib/ # Auth, utilities
154170
│ ├── pages/ # File-based routing
171+
│ │ └── api/ # Server-side API endpoints (D1)
155172
│ ├── styles/ # Global styles (Tailwind CSS)
156173
│ └── content.config.ts # Content schema definitions
157-
├── wrangler.toml # Cloudflare configuration
174+
├── wrangler.toml # Cloudflare Workers configuration
158175
└── astro.config.mjs # Astro configuration
159176
```
160177

0 commit comments

Comments
 (0)