Getting started 🚀

Clone this repo or deploy to Netlify

Nebulix 1.0 runs on Astro 7, Tailwind CSS v4, and Sveltia CMS. Easily deploy this theme to Netlify with a single click.

1. Setting up the .env file

Copy env.txt to .env and fill in your details:

cp env.txt .env

BLOG_SLUG=blog
PORTFOLIO_SLUG=work
MENU_SLUG=menu
WEBSITE_LANGUAGE=en
CURRENCY=USD
UNITS=metric
NEWSLETTER_PROVIDER=mailchimp
MAILCHIMP_API_KEY=XXXXXXXXXXXXXXXX-us21
MAILCHIMP_SERVER_PREFIX=us21
MAILCHIMP_LIST_ID=XXXXXXXXX
NODE_VERSION=22

[email protected]
[email protected]

MAILGUN_API_KEY=XXXXXXXXX
MAILGUN_DOMAIN=XXXXXXXXX
MAILGUN_API_URL=https://api.eu.mailgun.net

POSTMARK_SERVER_TOKEN=XXXXXXXXX

SLACK_CHANNEL_ID=XXXXXXXXX
SLACK_TOKEN=XXXXXXXXX

2. Configure Sveltia CMS

Edit src/pages/admin.astro and set your Git backend (GitHub by default):

backend: {
  name: "github",
  repo: "your-org/your-repo",
  branch: "main",
},

On localhost, Sveltia can work with the local repository via the File System Access API (“Work with local repository”). Point it at the git root (the folder that contains .git).

See Sveltia CMS backends for GitLab and other options.

3. Add your site to the Astro config

export default defineConfig({
  site: "https://your-website.com",
  // ...
});

4. Install dependencies

npm install

🛠️ 5. Start the development server

npm run dev

Open the site at http://localhost:4321 and the CMS at http://localhost:4321/admin/

❌ Removing collections

If you don’t need a blog, portfolio, or restaurant menu, remove the matching files under src/content and the page templates under src/pages.

🛸 Commands

Command	Action
npm install	Install dependencies
npm run dev	Local dev server (localhost:4321)
npm run check	Type-check with astro check
npm run build	Production build + Pagefind index → dist/
npm run preview	Preview the production build
npm run astro …	Astro CLI helpers

Deploy

Nebulix ships with the Netlify adapter so Astro Actions (contact + newsletter) can run on the server. You can swap to Cloudflare or Vercel — see the root README.

👀 Want to learn more about Astro?

Check out Astro documentation or jump into Astro’s Discord server.

📚 Tech stack

Astro 7, Sveltia CMS, Vue 3, Tailwind CSS v4, MDX, Pagefind, PhotoSwipe, Astro Actions

🛟 Support

If you encounter any issues or bugs, open an issue in the repository with steps to reproduce.

👑 Premium support

Need priority help, custom integrations, design, or development? Email [email protected] or find me on UpWork.

☕️ Buy me a coffee

Want to power late-night coding sessions? Buy me a coffee

📝 License

Want to remove the attribution? Purchase a license.