docs: add a Deployment section to the README - #1
Open
cayvox wants to merge 1 commit into
Open
Conversation
Signed-off-by: anilkaracay <anilkaracayy@gmail.com> Co-authored-by: Cayvox Labs <info@cayvox.com> Co-authored-by: anilkaracay <anilkaracayy@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a Deployment section to the README describing the static production recipe, mirroring the live PartyLayer demo app.
What it covers:
npm run build(tsc then vite build) emits static assets todist/.dist/to any static host (Caddy, Nginx, Netlify, Vercel static, GitHub Pages, S3 plus CDN). No server runtime is required for the app./index.html(Caddytry_files {path} /index.html, the Nginxtry_filesequivalent, and a Netlify/Vercel catch-all), otherwise deep links 404.public/directory, so a production deploy should add a robots.txt allowing indexing, a sitemap.xml, and a favicon set. Vite serves anything underpublic/at the site root.Every claim was verified against the repo: the package.json build script, the absence of a public/ directory and a .env.example, no env usage in src/, and the default Vite dist output.
Scope: README-only, 44 insertions. No em or en dashes were introduced. A scan of the existing README came back clean, so no dash fixes were needed.
Opening for review, not merging.