|
1 | | -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). |
| 1 | +# vortex.dev |
2 | 2 |
|
3 | | -## Getting Started |
| 3 | +Source for [vortex.dev](https://vortex.dev), the marketing site for [Vortex](https://github.com/vortex-data/vortex) — an extensible, state-of-the-art columnar file format. Vortex is a [Linux Foundation](https://www.linuxfoundation.org/) incubating project, a Series of LF Projects, LLC. |
4 | 4 |
|
5 | | -Start by install the [bun](https://bun.sh/) package manager. |
| 5 | +## Local development |
6 | 6 |
|
7 | | -Then, install dependencies and run the development server: |
| 7 | +Prerequisites: [Bun](https://bun.sh) ≥ 1.3.13 and Node ≥ 22. Bun is the package manager and script runner; Next.js itself runs on Node. |
8 | 8 |
|
9 | 9 | ```bash |
| 10 | +git clone git@github.com:vortex-data/vortex.dev.git |
| 11 | +cd vortex.dev |
10 | 12 | bun install |
11 | | -bun dev |
| 13 | +bun dev # Turbopack dev server on http://localhost:3000 |
12 | 14 | ``` |
13 | 15 |
|
14 | | -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
| 16 | +## Scripts |
15 | 17 |
|
16 | | -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. |
| 18 | +| Command | What it does | |
| 19 | +| --- | --- | |
| 20 | +| `bun dev` | Next.js dev server with Turbopack | |
| 21 | +| `bun run build` | Production build. Also runs velite to populate `.velite/` and emits `next-env.d.ts` | |
| 22 | +| `bun run start` | Production server (run after `build`) | |
| 23 | +| `bun run check` | Biome lint + format + import-organize, with auto-fix | |
| 24 | +| `bun run check:ci` | Biome no-write check — what CI runs | |
| 25 | +| `bun run typecheck` | `tsc --noEmit`. Must run after `bun run build` because velite populates `.velite/` and Next emits `next-env.d.ts` during build | |
| 26 | +| `bun run verify` | HTTP suite against a running server: sitemap, robots, RSS, OG, canonicals, JSON-LD, theme parity, `/api/subscribe`, internal links | |
| 27 | +| `bun run test:e2e` | Playwright browser smoke (Chromium desktop + WebKit iPhone-13). One-time setup: `bun run test:e2e:install` | |
| 28 | +| `bun run lighthouse` | Local Lighthouse CI run against `bun run start` | |
17 | 29 |
|
18 | | -This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. |
| 30 | +CI runs `check:ci → build → typecheck → start → verify → audit → playwright` on every PR via [.github/workflows/ci.yml](.github/workflows/ci.yml), plus an independent Lighthouse audit via [.github/workflows/lighthouse.yml](.github/workflows/lighthouse.yml) that posts a sticky score table. |
19 | 31 |
|
20 | | -**Note:** The deployment is managed by `bun`, so any dependency change should be managed by it and reflected in `bun.lock`. |
| 32 | +## Contributing |
21 | 33 |
|
22 | | -## Learn More |
| 34 | +The Developer Certificate of Origin is enforced on every commit. Sign off with: |
23 | 35 |
|
24 | | -To learn more about Next.js, take a look at the following resources: |
25 | | - |
26 | | -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
27 | | -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
28 | | - |
29 | | -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! |
| 36 | +```bash |
| 37 | +git commit -s |
| 38 | +``` |
30 | 39 |
|
31 | | -## Deploy on Vercel |
| 40 | +CI rejects PRs whose commits don't have a `Signed-off-by:` trailer (DCO probot check). |
32 | 41 |
|
33 | | -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. |
| 42 | +For architectural context — content pipeline, design tokens, audit advisories, deployment quirks — see [CLAUDE.md](CLAUDE.md). |
34 | 43 |
|
35 | | -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. |
| 44 | +For the Vortex file format itself and its tooling, see [github.com/vortex-data/vortex](https://github.com/vortex-data/vortex). |
0 commit comments