Docs · Beresta · Version 1.0.1

From repository to live site.

The full buyer documentation ships inside the repository. This is the short version, so you know what to expect before you buy. It is taken from the Beresta 1.0.1 release.

Back to Beresta

Install

From the repository to a running site and a production build.

Requirements

Requirement Version
Node.js 24.x
npm 11 or newer (ships with Node 24)
Git Any recent version
Operating system macOS, Linux, or Windows
Accounts or API keys None, and no secrets. A production build needs the site's URL (step 4).

Check your versions:

node -v   # v24.x.x
npm -v    # 11.x.x

1. Get the source

Clone the Beresta repository you were given access to, then start your own project from it. Your license does not allow the source in a public repository, and you cannot add anyone to the Beresta repository, so your project lives in a private repository of your own:

git clone https://github.com/vlavera/beresta.git my-house
cd my-house
git remote rename origin beresta      # keep it, to pull future releases
git remote add origin <your own private repository>
git push -u origin main

2. Install dependencies

npm ci

npm ci installs the exact versions in package-lock.json. It reports two moderate vulnerabilities in test tooling. That is expected; read docs/TROUBLESHOOTING.md before doing anything about it.

3. Run the site locally

npm run dev

Open http://localhost:4321 (or the port it prints). You'll see the demo: a fictional maker of objects for the house, kept out of search, with every concierge button going to the concierge section of the page.

To run your own configuration once you've created it (docs/CUSTOMIZE.md):

BERESTA_FIXTURE=client npm run dev                    # macOS / Linux
$env:BERESTA_FIXTURE="client"; npm run dev            # Windows PowerShell

Stop the development server with Ctrl+C in the terminal where it runs.

4. Check and build

npm run typecheck          # TypeScript and the configuration's shape
npm test                   # the configuration is coherent and its media files exist
SITE_URL=https://your-domain.com npm run build   # production build, into dist/
npm run preview            # serve the production build at http://localhost:4321 (Ctrl+C to stop)

npm run build and npm run dev check whichever configuration BERESTA_FIXTURE makes active, and stop, naming the path, if it references a photo that is not in public/house/. npm run build also stops if that configuration is switched on and still carries one of the demo's invented claims (docs/CUSTOMIZE.md, "What the build refuses").

The site URL

npm run build needs to know where the site will live, because the page carries a canonical link that points there. It looks in this order:

  1. SITE_URL in the environment, as in the command above (PowerShell: $env:SITE_URL="https://your-domain.com"; npm run build).
  2. seo.siteUrl in your configuration (docs/CUSTOMIZE.md).
  3. The project's production domain, when Vercel builds the site from a connected Git repository. A build run anywhere else does not have it.

If none of these gives a real https:// URL, the build stops and says so. There is no placeholder that quietly works. npm run dev does not need it.

Next steps

  • Make it your own house: docs/CUSTOMIZE.md.
  • Replace the example photos and understand their license: docs/ASSETS.md.
  • Deploy: docs/DEPLOY.md.

Customize

Everything that makes a Beresta site one house is in one file: the configuration, src/house/fixtures/*.ts. Every word, price and photo is there, with the facts they belong to. Its shape is HouseContract in src/house/contract.ts, where every field is described.

The full guide, docs/CUSTOMIZE.md in the repository, covers:

  • Start your own configuration
  • What to change, and where
  • Switching the site on
  • One language
  • Colours and type
  • Next steps

Assets

The full guide, docs/ASSETS.md in the repository, covers:

  • Where media lives
  • The example photographs are AI-generated. Read this before you ship
  • The velvet ground
  • What the build checks
  • Replacing the example photographs

Deploy

Beresta builds to a static site (npm run build produces dist/): no server process, no adapter, no secrets. The build needs the site's URL. When Vercel builds the site from a connected Git repository it is picked up automatically; anywhere else, set SITE_URL (docs/INSTALL.md, "The site URL").

Deployment is tested on Vercel through its Git integration, on a plan that permits commercial use. The Vercel CLI path and other hosting environments are untested in this release.

The full guide, docs/DEPLOY.md in the repository, covers:

  • Git integration
  • Deploy with the Vercel CLI
  • Connect your domain
  • Verify a deployment
  • Other hosts

Troubleshooting

14 calendar days of email support from the order date, for installation and the Vercel Git-integration deployment documented in the package. There is no response-time promise, and customization work, other hosts, and general development consulting are outside it.

The full guide, docs/TROUBLESHOOTING.md in the repository, covers:

  • npm ci reports vulnerabilities. Is that a problem?
  • npm run build stops with "no usable site URL"
  • npm run build stops with "still carries the demo's …"
  • The concierge buttons only move the page
  • "Ask about this object" opens my contact page with no message
  • An object does not appear in the catalogue
  • A signature card is missing
  • Choosing an object does nothing
  • The second button of the bar on phones is missing
  • Nothing fades in, and no light follows the pointer

Changelog

All notable changes to Beresta are recorded here. Versions follow Semantic Versioning.

1.0.1

  • README.md and this file described the build's check on the demo's claims as covering whole kinds of claim: the history, the promises. It covers the claims on its list, each by its exact words, and no others. Both now say so. Nothing in the theme's code or pages changed.

1.0.0

First release.

  • A maker's site in one page: a hero, three signature objects, the catalogue, the workshop, commissions, the house's history, four promises, notes from clients, the showroom, the concierge, and questions.
  • A catalogue in cases, one tab each, and a detail view for every object with its description, materials, size and care.
  • No cart: every concierge button goes to the one contact you configure, and from an object the link carries a first line naming it, where the link can carry one.
  • A build check for the demo's invented claims: the build refuses a switched-on site that still carries one of the claims it lists. docs/CUSTOMIZE.md has the list.
  • Buyer guides in docs/, AGENTS.md for coding agents, and the license.

Known limitations

  • One house, one page, one language (English).
  • No CMS: content is a TypeScript file in src/house/fixtures/. The catalogue is what that file says; changing it is an edit and a deploy.
  • No cart, checkout, payments or stock. A concierge button is a link to wherever you take enquiries. A message is carried by an email or WhatsApp link only.
  • The catalogue's tabs and an object's detail view need the page's script. Without it the first case is shown.
  • No map is shown. The address and opening hours are text you write.
  • Colours and typefaces are CSS, not configuration.
  • The example photographs are AI-generated and must be replaced before a commercial site goes live (LICENSE.md section 8).
  • Deployment is verified on Vercel through its Git integration only.