Skip to content

README.md

Latest commit

 

History

History
88 lines (63 loc) · 2.64 KB

README.md

File metadata and controls

88 lines (63 loc) · 2.64 KB

Openable.dev

Marketing and developer site for Openable.dev, a desktop app that helps people run AI-generated projects locally without installing Node.js, using terminal commands, or configuring a development environment.

About

Openable.dev is built for creators working with projects generated by tools like Lovable, Bolt, v0, and similar AI code generation platforms. The site explains the product, shows the main workflow, collects beta signups, and exposes crawler-friendly metadata files such as robots.txt, sitemap.xml, and llms.txt.

Stack

Getting Started

Install dependencies:

pnpm install

Start the local development server:

pnpm dev

Open http://localhost:3000 in your browser.

Scripts

pnpm dev        # Start the Next.js dev server with Turbopack
pnpm build      # Build the static site into out/
pnpm start      # Serve a production Next.js build
pnpm lint       # Run oxlint
pnpm lint:fix   # Run oxlint with fixes
pnpm fmt        # Format the repo with oxfmt
pnpm fmt:check  # Check formatting

Project Structure

src/app/          App Router pages, metadata, robots, and sitemap routes
src/components/   Shared UI and page-level components
src/sections/     Homepage sections
src/copy/         English copy used by next-intl
src/static/       Global CSS and imported image assets
src/utils/        Shared constants and helpers
public/           Static public files, including llms.txt and background images

SEO and Metadata

  • Site URL lives in src/utils/constants.ts as APP_URL.
  • Page metadata is exported from src/app/layout.tsx.
  • /robots.txt is generated by src/app/robots.ts.
  • /sitemap.xml is generated by src/app/sitemap.ts.
  • /llms.txt is maintained as public/llms.txt.

Because this app uses output: "export", generated metadata routes must remain statically renderable.

Deployment

The site is deployed to GitHub Pages by .github/workflows/deploy.yml whenever changes are pushed to main.

The workflow:

  1. Installs dependencies with pnpm.
  2. Runs pnpm build.
  3. Uploads the out/ directory as a Pages artifact.
  4. Deploys with actions/deploy-pages.

Quality Checks

Before pushing changes, run:

pnpm lint
pnpm fmt:check
pnpm build