nuartz is a Next.js application that supports both static export (GitHub Pages) and server-side deployment (Vercel, Netlify). See the full hosting guide for all options including GitHub Pages.
- Your nuartz project is pushed to a GitHub repository.
- The
apps/web/content/directory is committed to the repo (not gitignored).
Deploy to Vercel
1. Push to GitHub
Make sure all your content and configuration is committed:
git add .
git commit -m "initial content"
git push2. Import the repository in Vercel
- Go to vercel.com/new and click Add New Project.
- Select Import Git Repository and choose your nuartz repo.
- Vercel auto-detects Next.js - leave the framework preset as Next.js.
- Set the root directory to
apps/web. The install and build commands come fromapps/web/vercel.json(cd ../.. && bun run build).
3. Set the site URL
Set site.baseUrl in apps/web/nuartz.config.ts to your production URL, or add an environment variable before deploying:
| Name | Value |
|---|---|
NUARTZ_SITE_URL | https://your-domain.vercel.app |
It is used for canonical URLs, the sitemap, RSS, and OG tags. Update it to your custom domain once you have one.
4. Deploy
Click Deploy. Vercel runs bun run build (package build, generate, then next build) and publishes it. Your site is live at <project>.vercel.app within a minute or two.
Every push to the main branch triggers a new production deployment automatically. Pull requests get preview deployments at unique URLs.
Custom domain
- Go to your project in the Vercel dashboard and open Settings > Domains.
- Enter your domain and follow the DNS instructions.
- Update
site.baseUrl(orNUARTZ_SITE_URL) to match the new domain and redeploy.
Content updates
Because apps/web/content/ is part of the repo, updating your notes is just a git push:
# edit apps/web/content/notes/my-note.md
git add apps/web/content/
git commit -m "update notes"
git pushVercel picks up the push and rebuilds automatically.
nuartz reads content files from disk at build time (bun run generate). If apps/web/content/ is gitignored, the build will produce an empty site.
Local production preview
Test the production build locally before deploying:
bun run build
bun run --cwd apps/web startOpen http://localhost:3000 to verify everything looks correct.
Related
- Getting Started - local development setup
- Configuration -
nuartz.config.tsreference - Private Pages - exclude draft content from builds