{"id":14959227,"url":"https://github.com/unfolding-io/nebulix","last_synced_at":"2025-04-06T03:11:44.705Z","repository":{"id":192544791,"uuid":"686950348","full_name":"unfolding-io/nebulix","owner":"unfolding-io","description":"Nebulix, a Fast \u0026 Green Theme Based on Astro + Static CMS + Snipcart","archived":false,"fork":false,"pushed_at":"2024-03-14T06:58:11.000Z","size":48526,"stargazers_count":270,"open_issues_count":3,"forks_count":122,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-03-30T02:07:31.562Z","etag":null,"topics":["astro","astro-template","astro-theme","ecommerce","mailchimp","mailgun","pagefind-js","slack","snipcart","static-cms","tailwind","template","vue3"],"latest_commit_sha":null,"homepage":"https://nebulix.unfolding.io/","language":"Astro","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/unfolding-io.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-04T09:40:53.000Z","updated_at":"2025-03-23T19:18:59.000Z","dependencies_parsed_at":"2023-10-23T09:31:00.329Z","dependency_job_id":"ff5ef2a9-1569-4deb-9e62-1f7ddb4eb42f","html_url":"https://github.com/unfolding-io/nebulix","commit_stats":{"total_commits":66,"total_committers":2,"mean_commits":33.0,"dds":0.06060606060606055,"last_synced_commit":"8d77f1960de3c41434a3ec213b78cc04179408eb"},"previous_names":["unfolding-io/nebulix"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfolding-io%2Fnebulix","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfolding-io%2Fnebulix/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfolding-io%2Fnebulix/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfolding-io%2Fnebulix/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unfolding-io","download_url":"https://codeload.github.com/unfolding-io/nebulix/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247427012,"owners_count":20937213,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["astro","astro-template","astro-theme","ecommerce","mailchimp","mailgun","pagefind-js","slack","snipcart","static-cms","tailwind","template","vue3"],"created_at":"2024-09-24T13:19:11.922Z","updated_at":"2025-04-06T03:11:44.691Z","avatar_url":"https://github.com/unfolding-io.png","language":"Astro","funding_links":["https://www.buymeacoffee.com/unfolding.io"],"categories":["Astro"],"sub_categories":[],"readme":"# Nebulix | Astro + Static CMS\n\n[![License: CC BY-ND 4.0](https://img.shields.io/badge/License-CC_BY--ND_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nd/4.0/)\n\n\n\n\nA Universe of Possibilities: Blogs, Portfolios, Webshop, Restaurant Menus, and Beyond.\n\n\n\n![Nebulix](https://nebulix.unfolding.io/screenshots/nebulix-00-start.jpg)\n\n## Notice\n\n__This theme is currently under development, and until we reach version 1.0.0, there is a possibility that upgrading could lead to errors.__\n\n## 🛠️Deploy\nEasily deploy this theme to Netlify with a single click, and conveniently update environment variables afterward on Netlify.\n\n\n\n[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/unfolding-io/nebulix#BLOG_SLUG=blog\u0026PORTFOLIO_SLUG=work\u0026SHOP_SLUG=shop\u0026MENU_SLUG=menu\u0026WEBSITE_LANGUAGE=en\u0026CURRENCY=USD\u0026UNITS=metric\u0026NODE_VERSION=18)\n\n\n## Constellations of Features:\n\n-   📰 Chart Your Path with a Blog\n-   🖼 Showcase Your Stellar Portfolio\n-   🍝 Illuminate Culinary Voyages with a Restaurant Menu\n-   🛒 Launch Your Webshop Powered by Snipcart\n-   🔍 SEO Constellations: Canonical URLs and OpenGraph radiance\n-   🧭 Navigational Maps: Sitemap Support\n-   📑Language of the Stars: Markdown \u0026 MDX Support\n-   📝 Static CMS Ready for Galactic Exploration\n- \t🐵 Mailchimp newsletter form\n-   🕵 Unveil Hidden Constellations with Full Text Search using Pagefind\n\n## ♻️ Page Speed and Emissions\nExperience the green and swift capabilities of Nebulix. With an impressively low emission of 0.05g - 0.07g CO2 per page visit and consistently achieving a lighthouse score between 98 and 100, Nebulix ensures both speed and environmental consciousness for your website.\n\n## 🚀 Getting Started\n\n### 1. Setting up the .env file\n\nrename the `env.txt` to `.env` and fill in your details\n\n```ENV\nBLOG_SLUG=blog\nPORTFOLIO_SLUG=work\nSHOP_SLUG=shop\nMENU_SLUG=menu\nWEBSITE_LANGUAGE=en\nCURRENCY=USD\nUNITS=metric\nSNIPCART_KEY=\u003cyour-snipcart-public-key\u003e\nNODE_VERSION=18\nNEWSLETTER_PROVIDER=mailchimp\nMAILCHIMP_API_KEY=XXXXXXXXXXXXXXXX-us21\nMAILCHIMP_SERVER_PREFIX=us21\t\nMAILCHIMP_LIST_ID=XXXXXXXXX\n\nFROM_EMAIL_ADDRESS=[test@email.com](mailto:test@email.com)\nTO_EMAIL_ADDRESS=[test@email.com](mailto:test@email.com)\n\nMAILGUN_API_KEY=XXXXXXXXX\nMAILGUN_DOMAIN=XXXXXXXXX\nMAILGUN_API_URL=\u003chttps://api.eu.mailgun.net\u003e\n\nPOSTMARK_SERVER_TOKEN=XXXXXXXXX\n\nSLACK_CHANNEL_ID=XXXXXXXXX\nSLACK_TOKEN=XXXXXXXXX\n\n```\n\n### 2. Configure your Static CMS Backend\n\nNavigate to `src/pages/admin.astro` and provide your Git repository details. You can find a list of all supported Git backends at:\n\u003chttps://www.staticcms.org/docs/backends-overview\u003e\n\n\n**_Gitlab Example:_**\n\n```javascript\n\nconst config = {\n\tlocale: lang,\n\tsite_url: url,\n\tlogo_url: 'https://nebulix.unfolding.io/nebulix-logo.svg',\n\tlocal_backend: true,\n\tbackend: {\n\t\tname: 'gitlab',\n\t\trepo: '/\u003cyour-gitlab-repo\u003e',\n\t\tauth_type: 'pkce', // Required for pkce\n\t\tapp_id: 'xxxx', // Application ID from your GitLab settings\n\t\tcommit_messages: {\n\t\t\tcreate: 'Create {{collection}} \"{{slug}}\"',\n\t\t\tupdate: 'Update {{collection}} \"{{slug}}\"',\n\t\t\tdelete: 'Delete {{collection}} \"{{slug}}\"',\n\t\t\tuploadMedia: 'Upload \"{{path}}\"',\n\t\t\tdeleteMedia: 'Delete \"{{path}}\"'\n\t\t}\n\t},\n\tsearch: 'true',\n    ....\n}\n\n```\n\n### 3. Add your site to the astro config\n\n```javascript\n\nexport default defineConfig({\n\tsite: 'https://your-website.com',\n    ....\n\n```\n\n### 4. Install dependencies\n\n```bash\n$ npm install\n```\n\n### 🛠️ 5. Start Development server\n\n```bash\n$ npm run dev\n```\n\nIf you wish to engage the local backend:\n\n```bash\n$ npm run cms-proxy-server\n```\n\nNow you can open Static CMS on http://localhost:4321/admin/\n\n\n## ❌ Removing Collections\nIf your cosmic journey excludes a blog, portfolio, shop, or restaurant menu, simply remove the corresponding documents from the `src/content`. Additionally, erase the page templates from `src/pages` .\n\n\n## 🛸 Commands\n\nAll commands are run from the root of the project, from a terminal:\n\n| Command                    | Action                                           |\n| :------------------------- | :----------------------------------------------- |\n| `npm install`              | Installs dependencies                            |\n| `npm run dev`              | Starts local dev server at `localhost:4321`      |\n| `npm run cms-proxy-server` | Starts Static CMS proxy server for local-backend |\n| `npm run build`            | Build your production site to `./dist/`          |\n| `npm run preview`          | Preview your build locally, before deploying     |\n| `npm run astro ...`        | Run CLI commands like `astro add`, `astro check` |\n| `npm run astro -- --help`  | Get help using the Astro CLI                     |\n\n## 📁 Documentation\nLearn how to harness the power of Static CMS and craft a distinctive website that stands out from the crowd.\n\n[Documentation](https://nebulix.unfolding.io/blog/tag/docs)\n\n## 🌐 Demo\n\nWitness the extraordinary speed of Nebulix in action.\n\n[Demo](https://nebulix.unfolding.io)\n\n## 👀 Want to learn more about Astro?\n\nCheck out [Astro documentation](https://docs.astro.build) or jump into Astro's [Discord server](https://astro.build/chat).\n\n## 📚 Tech Stack\n\nAstro, MDX, Vue, TailwindCSS, Pagefind, Snipcart\n\n## 🛟 Support\n\nIf you encounter any issues or bugs, we encourage you to open an issue in the repository. To help us quickly address the problem, please provide detailed information about the bug and steps to reproduce it.\n\n## 👑 Premium Support\n\nFor those seeking priority assistance, we offer premium support services. Do you need support, custom intergrations, design, or development? Feel free to reach out to me by email at [hello@unfolding.io.](mailto:hello@unfolding.io.) find me on [UpWork](https://www.upwork.com/freelancers/~01dcde6b3915c74c30) Im here to help!\n\n\n## 📝 License\n\nWant to get rid of the attribution? Simply [purchase a license](https://nebulix.unfolding.io/shop/nebulix-license/) and you're good to go.\n\n## 🚕 Roadmap\n\nAs we journey towards v1.0, our path includes enriching the page builder with a diverse array of new blocks, upgrading dependencies to ensure optimal performance, and introducing exciting features. We're eager to hear from you! If you have any feature requests, please feel free to reach out and let us know.\n\n## ☕️ Want to Caffeinate your Developer?\n\nBy [caffeinating](https://www.buymeacoffee.com/unfolding.io) your developer, you're not just getting the best out of them; you're also ensuring a cheerful and energetic work environment.😊\n\n[![buymeacoffee](https://starfunnel.unfolding.io/screenshots/bymeacoffee.webp)](https://www.buymeacoffee.com/unfolding.io)\n\n\n\n## 📸 Screenshots\n\n![Nebulix](https://nebulix.unfolding.io/screenshots/nebulix-01-shop.jpg)\n\n![Nebulix](https://nebulix.unfolding.io/screenshots/nebulix-02-shop-category.jpg)\n\n![Nebulix](https://nebulix.unfolding.io/screenshots/nebulix-03-shop-product.jpg)\n\n![Nebulix](https://nebulix.unfolding.io/screenshots/nebulix-04-shop-product.jpg)\n\n![Nebulix](https://nebulix.unfolding.io/screenshots/nebulix-05-shop-product-dark.jpg)\n\n![Nebulix](https://nebulix.unfolding.io/screenshots/nebulix-06-blogpost.jpg)\n\n![Nebulix](https://nebulix.unfolding.io/screenshots/nebulix-07-portfolio.jpg)\n\n![Nebulix](https://nebulix.unfolding.io/screenshots/nebulix-08-footer.jpg)\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funfolding-io%2Fnebulix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funfolding-io%2Fnebulix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funfolding-io%2Fnebulix/lists"}