{"id":30713115,"url":"https://github.com/blazium-engine/shoyo-hostable","last_synced_at":"2025-10-25T13:42:47.349Z","repository":{"id":306520887,"uuid":"1026463861","full_name":"blazium-engine/shoyo-hostable","owner":"blazium-engine","description":"shoyo-hostable is the self-hostable version of shoyo.work, a Linktr.ee-style SaaS tailored for developers, creators, and professionals to showcase their projects, portfolios, and work history.","archived":false,"fork":false,"pushed_at":"2025-07-26T02:46:41.000Z","size":21,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-07-26T07:31:35.585Z","etag":null,"topics":["blazium","docker","gamedev","open-source","portfolio"],"latest_commit_sha":null,"homepage":"https://shoyo.work/","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/blazium-engine.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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,"zenodo":null}},"created_at":"2025-07-26T00:08:42.000Z","updated_at":"2025-07-26T02:49:55.000Z","dependencies_parsed_at":"2025-07-26T07:32:21.194Z","dependency_job_id":"86c9719a-e1df-41e5-b545-8ea355397a11","html_url":"https://github.com/blazium-engine/shoyo-hostable","commit_stats":null,"previous_names":["blazium-engine/shoyo-hostable"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/blazium-engine/shoyo-hostable","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blazium-engine%2Fshoyo-hostable","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blazium-engine%2Fshoyo-hostable/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blazium-engine%2Fshoyo-hostable/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blazium-engine%2Fshoyo-hostable/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blazium-engine","download_url":"https://codeload.github.com/blazium-engine/shoyo-hostable/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blazium-engine%2Fshoyo-hostable/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273382179,"owners_count":25095406,"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","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["blazium","docker","gamedev","open-source","portfolio"],"created_at":"2025-09-03T03:12:08.952Z","updated_at":"2025-10-25T13:42:42.317Z","avatar_url":"https://github.com/blazium-engine.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# shoyo-hostable\n\n**shoyo-hostable** is the self-hostable version of [shoyo.work](https://shoyo.work), a Linktr.ee-style SaaS tailored for developers, creators, and professionals to showcase their projects, portfolios, and work history.\n\nThis project provides a minimal **Docker-based solution** to deploy a fully functional, public-facing portfolio page based on data stored on the main Shoyo platform. It renders a customizable frontend using only two required environment variables.\n\n---\n\n## 🚀 Features\n\n- ✅ Self-hostable Docker container  \n- 🎨 Custom theme templating support (WIP)  \n- 🔐 Securely displays only your public portfolio data  \n- ⚡ Instant deploy with just two variables  \n- 🌍 Great for developer sites, resumes, landing pages, or personal branding  \n\n---\n\n## 📦 Requirements\n\n- Docker installed  \n- A valid Shoyo `PAGE_UID` and `PUBLIC_KEY`  \n\nYou can get these from your [Shoyo Dashboard](https://shoyo.work).\n\n---\n\n## 🛠️ Environment Variables\n\n| Variable      | Description                                                        |\n|---------------|--------------------------------------------------------------------|\n| `PAGE_UID`    | Your unique Shoyo page identifier (public-facing)                 |\n| `PUBLIC_KEY`  | The public key used to verify and fetch public data securely      |\n\n---\n\n## 🐳 Usage (Docker)\n\n### 🔧 Step 1: Create `.env`\n\n```env\nPAGE_UID=your_page_uid_here\nPUBLIC_KEY=your_public_key_here\n````\n\n### 📦 Step 2: Run Docker\n\n```bash\ndocker run -d \\\n  -e PAGE_UID=your_page_uid_here \\\n  -e PUBLIC_KEY=your_public_key_here \\\n  -p 3000:3000 \\\n  ghcr.io/shoyo/shoyo-hostable:latest\n```\n\nOr using a `docker-compose.yml`:\n\n```yaml\nversion: \"3\"\n\nservices:\n  shoyo:\n    image: ghcr.io/shoyo/shoyo-hostable:latest\n    restart: always\n    ports:\n      - \"3000:3000\"\n    environment:\n      PAGE_UID: your_page_uid_here\n      PUBLIC_KEY: your_public_key_here\n```\n\nThen run:\n\n```bash\ndocker-compose up -d\n```\n\n---\n\n## 🌐 Access Your Page\n\nAfter deployment, visit:\n👉 `http://localhost:3000` (or your server IP/domain)\nto view your portfolio.\n\n---\n\n## 📁 Customization\n\nThis project supports basic theming and templating in future versions. You'll be able to:\n\n* Customize layout and colors\n* Host assets (images, icons) locally\n* Switch between pre-defined templates\n\nStay tuned for upcoming updates!\n\n---\n\n## 🤖 LLM Support\n\nTo enhance automatic documentation generation and improve onboarding for tools like ChatGPT or GitHub Copilot, this project includes:\n\n* **[`_llm_summary.md`](./_llm_summary.md)**: A metadata file describing the project structure, usage expectations, and LLM-guided goals.\n* **`project_structure.md`**: Auto-generated tree and context for LLMs and human readers.\n\nThese files can be used to build accurate AI-generated READMEs, contribution guides, and code summaries.\n\n---\n\n## ❤️ Powered by Shoyo\n\nThis project fetches and renders public portfolio data via [shoyo.work](https://shoyo.work). To create your portfolio, visit the official platform and generate your `PAGE_UID` and `PUBLIC_KEY`.\n\n---\n\n## 📄 License\n\nMIT License – Use, modify, and self-host freely.\n\n---\n\n## ✨ Example Use Cases\n\n* Personal developer portfolio\n* Project showcase site\n* Resume landing page\n* GitHub bio link page\n* Startup or team presentation\n\n---\n\n## 🤝 Contributions\n\nHave ideas or want to contribute custom themes or render logic?\nPRs welcome, or contact us at [shoyo.work](https://shoyo.work).\n\nJoin the community: [Discord](https://discord.gg/Vbq4zGdaVs)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblazium-engine%2Fshoyo-hostable","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblazium-engine%2Fshoyo-hostable","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblazium-engine%2Fshoyo-hostable/lists"}