From repository to live site.

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 Ush 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 Ush repository, so your project lives in a private repository of your own:

git clone https://github.com/vlavera/ush.git my-bar
cd my-bar
git remote rename origin ush        # 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 bar, kept out of search, with every contact button inert and a table request that can be filled in and goes nowhere.

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

USH_FIXTURE=client npm run dev                    # macOS / Linux
$env:USH_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 USH_FIXTURE makes active, and stop, naming the path, if it references a photo that is not in public/bar/. 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 bar: docs/CUSTOMIZE.md.
• Replace the example photos and understand their license: docs/ASSETS.md.
• Deploy: docs/DEPLOY.md.

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

Ush 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").

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

1.0.0

First release.

• A late bar's site in one page: a hero, the room, tonight and the week, the list of drinks, the kitchen, where to sit, a table request, how to find the door, and a footer.
• It says whether the bar is open: open, last orders or closed, from your opening hours and your time zone, worked out when the page is built and again in the visitor's browser every minute. A night that runs past midnight belongs to the day it opened on.
• Drinks in groups and dishes, each with a photo, a note and a price; choosing one shows how it is made.
• A table request: a visitor chooses how many, which night and what time, and gives a name; the page builds a sentence, and the button opens the one contact you configure with that sentence in the message, 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 bar, one page, one language (English).
• No CMS: content is a TypeScript file in src/bar/fixtures/. The list is what that file says; changing it is an edit and a deploy.
• No booking system. The table request does not know whether a table is free, holds nothing and sends nothing: its button is a link to wherever you take requests. The request is carried by an email or WhatsApp link only.
• Open and closed need opening hours that are the same every week. A one-off closure is an edit and a deploy.
• The table request needs the page's script. Without it the rest of the page is complete, with every drink's method shown.
• No map: the drawing beside the address shows no real place, and there is no map link.
• The opening hours are written as text in several places besides the hours the clock uses, and nothing keeps them in step.
• 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). Six of the drink photographs have words in them that do not match the drinks' names (docs/ASSETS.md).
• Deployment is verified on Vercel through its Git integration only.