Docs · Ember · Version 1.0.0
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 Ember 1.0.0 release.
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 Ember 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 Ember repository, so your project lives in a private repository of your own:
git clone https://github.com/vlavera/ember.git my-hotel
cd my-hotel
git remote rename origin ember # 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 hotel, kept out of search. Its enquiry drawer opens and takes choices, and its button and every contact link go nowhere.
To run your own configuration once you've created it (docs/CUSTOMIZE.md):
EMBER_FIXTURE=client npm run dev # macOS / Linux
$env:EMBER_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 EMBER_FIXTURE makes active, and
stop, naming the path, if it references a photo that is not in public/hotel/. npm run build
also stops if that configuration is switched on and still carries one of the demo's 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:
SITE_URLin the environment, as in the command above (PowerShell:$env:SITE_URL="https://your-domain.com"; npm run build).seo.siteUrlin your configuration (docs/CUSTOMIZE.md).- 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 hotel:
docs/CUSTOMIZE.md. - Replace the example photos and understand their license:
docs/ASSETS.md. - Deploy:
docs/DEPLOY.md.
Customize
Everything that makes an Ember site one hotel is in one file: the configuration,
src/hotel/fixtures/*.ts. Every word and photo is there, with the facts they belong to. Its shape
is HotelContract in src/hotel/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
- What the build checks
- Replacing the example photographs
Deploy
Ember 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 cireports vulnerabilities. Is that a problem?npm run buildstops with "no usable site URL"npm run buildstops with "still carries the demo's …"- The drawer's button does nothing
- The drawer's button opens my link, but the dates are not in it
- The email opens with no line breaks, or does not open
- "Call the house" does not appear in the footer
- Nothing fades in, and all the windows are lit at once
Changelog
All notable changes to Ember are recorded here. Versions follow Semantic Versioning.
1.0.0
First release.
- A small hotel's site in one page: a hero, the house, a lit facade with one window per room, a gallery, the kinds of room, the bar, the street and what is near it, what to know before arriving, and a last word.
- An enquiry drawer: preferred dates, number of guests and a kind of room. On a site that is switched on, its button opens your email or WhatsApp link with those choices in the message.
- A build check that stops a switched-on site still carrying the demo's guest quote or its measurements.
- Buyer guides in
docs/,AGENTS.mdfor coding agents, and the license.
Known limitations
- One hotel, one page, one language (English).
- No CMS: content is a TypeScript file in
src/hotel/fixtures/. Changing it is an edit and a deploy. - No bookings, payments, rates engine or availability. The drawer writes a message; it does not know whether a room is free, and a rate is text you write.
- The drawer's choices travel only in an email link or a WhatsApp link. With any other contact link the button opens the link and carries nothing.
- No map and no directions link.
- Colours and typefaces are CSS, not configuration.
- The example photographs are AI-generated and must be replaced before a commercial site goes live
(
LICENSE.mdsection 8). - Deployment is verified on Vercel through its Git integration only.