{"id":30803122,"url":"https://github.com/cubbit/slideshow-demo","last_synced_at":"2026-05-10T07:54:39.099Z","repository":{"id":283059089,"uuid":"949370753","full_name":"cubbit/slideshow-demo","owner":"cubbit","description":"Cubbit DS3 slideshow demo","archived":false,"fork":false,"pushed_at":"2025-08-30T10:36:49.000Z","size":11222,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-05T22:48:31.567Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://cubbit.io","language":"TypeScript","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/cubbit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-03-16T09:59:26.000Z","updated_at":"2025-05-21T07:37:53.000Z","dependencies_parsed_at":"2025-09-05T22:39:39.109Z","dependency_job_id":"167a982b-791c-4c52-99d1-50958650b1ea","html_url":"https://github.com/cubbit/slideshow-demo","commit_stats":null,"previous_names":["marmos91/cubbit-slideshow-demo","cubbit/slideshow-demo"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cubbit/slideshow-demo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cubbit%2Fslideshow-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cubbit%2Fslideshow-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cubbit%2Fslideshow-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cubbit%2Fslideshow-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cubbit","download_url":"https://codeload.github.com/cubbit/slideshow-demo/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cubbit%2Fslideshow-demo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279002685,"owners_count":26083442,"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-10-10T02:00:06.843Z","response_time":62,"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":[],"created_at":"2025-09-05T22:39:35.173Z","updated_at":"2025-10-10T04:16:39.912Z","avatar_url":"https://github.com/cubbit.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cubbit Slideshow Demo\n\n![Slideshow](./assets/slideshow.png)\n\nA modern web application for uploading and displaying photos in a beautiful slideshow using Cubbit DS3 or any S3-compatible storage.\n\n## 📸 Features\n\n- **Simple Upload Interface**: Easily upload photos from any device\n- **Dynamic Slideshow**: Automatically refreshing slideshow with smooth animations\n- **S3 Integration**: Works with Cubbit DS3 or any S3-compatible storage\n- **Administrative Settings**: Secure admin panel to configure storage settings\n- **Responsive Design**: Works on desktop, tablet, and mobile devices\n- **Kubernetes Deployment**: Ready-to-use Helm chart for easy deployment\n- **Multi-Architecture Support**: Docker images available for both amd64 and arm64\n\n## 📷 Screenshots\n\n![Upload](./assets/upload.png)\n![Slideshow](./assets/slideshow.png)\n![Settings](./assets/settings.png)\n\n## 🚀 Getting Started\n\n### Prerequisites\n\n- Node.js 18+ (or 20+ for optimal performance)\n- npm 9+\n- S3-compatible storage (Cubbit DS3, AWS S3, MinIO, etc.)\n\n### Development Setup\n\n1. Clone the repository:\n\n    ```bash\n    git clone \u003chttps://github.com/cubbit/slideshow-demo.git\u003e\n    cd slideshow-demo\n    ```\n\n    Install dependencies:\n\n    ```bash\n    npm install\n    ```\n\n2. Create a `.env.local` file with your S3 credentials:\n\n    ```\n    # Public settings (available on client)\n\n    NEXT_PUBLIC_S3_BUCKET_NAME=your-bucket-name\n    NEXT_PUBLIC_MAX_FILE_SIZE=10485760\n    NEXT_PUBLIC_SLIDESHOW_SPEED_S=40\n    NEXT_PUBLIC_MIN_COUNT_FOR_MARQUEE=6\n    NEXT_PUBLIC_S3_ENDPOINT=\u003chttps://your-s3-endpoint\u003e\n\n    # Private settings (server only)\n\n    S3_REGION=eu-central-1\n    S3_ACCESS_KEY_ID=your-access-key\n    S3_SECRET_ACCESS_KEY=your-secret-key\n    MULTIPART_THRESHOLD=5242880\n\n    # Authentication for settings page\n\n    AUTH_USERNAME=admin\n    AUTH_PASSWORD=secure-password\n    JWT_SECRET=your-random-jwt-secret\n    ```\n\n3. Start the development server:\n\n    ```bash\n    npm run dev\n    ```\n\n4. Open \u003chttp://localhost:3000\u003e in your browser.\n\n## 🐳 Docker Deployment\n\n### Building Docker Images\n\n#### Standard Build\n\n```bash\ndocker build -t cubbit/slideshow-demo:latest .\n```\n\n#### Multi-Architecture Build\n\nThe repository includes a script for building multi-architecture images (amd64/arm64):\n\n```bash\n# Build image with default settings (Node.js 18, tag: latest)\n\nnpm run docker:build\n\n# Build with specific Node.js version and tag\n\nnpm run docker:build -- -v 1.2.0 -n 20\n\n# Build and push to registry\n\nnpm run docker:build -- -v 1.2.0 -p\n```\n\nFor more advanced build options, see the [Multi-Architecture Build Guide](docs/MULTIARCH-BUILD-GUIDE.md).\n\n## ☸️ Kubernetes Deployment with Helm\n\nThe application can be deployed to Kubernetes using the included Helm chart.\n\n### Quick Start\n\n```bash\n\n# Create your values file\n\ncp helm/values.yaml my-values.yaml\n\n# Edit my-values.yaml with your S3 credentials and settings\n\nnano my-values.yaml\n\n# Install the chart\n\nhelm install slideshow ./helm -f my-values.yaml\n```\n\n### Advanced Configuration\n\nFor complete installation and configuration details, see [Installation Guide](docs/HOW-TO-INSTALL.md).\n\n## ⚙️ Configuration Options\n\nThe application can be configured via environment variables or through the settings UI.\n\nKey Configuration Parameters\n\n|       Parameter       |                  Description                  |     Default     |\n| :-------------------: | :-------------------------------------------: | :-------------: |\n|    S3_BUCKET_NAME     |             Name of the S3 bucket             |    slideshow    |\n|     MAX_FILE_SIZE     |       Maximum upload file size (bytes)        | 10485760 (10MB) |\n|   SLIDESHOW_SPEED_S   |   Duration of slideshow animation (seconds)   |       40        |\n| MIN_COUNT_FOR_MARQUEE | Minimum photos before enabling marquee effect |        6        |\n|       S3_REGION       |                   S3 region                   |  eu-central-1   |\n|      S3_ENDPOINT      |                S3 endpoint URL                |    Required     |\n|   S3_ACCESS_KEY_ID    |                 S3 access key                 |    Required     |\n| S3_SECRET_ACCESS_KEY  |                 S3 secret key                 |    Required     |\n\n## Settings UI\n\nOnce deployed, you can access the settings page at `/settings` using the credentials defined in your configuration.\n\n## 🔒 Security Considerations\n\n- Change default admin credentials before deployment\n- Use HTTPS in production with a valid TLS certificate\n- Consider rate limiting and firewall rules for public instances\n- Review Kubernetes security best practices if deploying to production clusters\n\n## 🧑‍💻 Development\n\n### Core Technologies\n\n- **Next.js**: React framework with server-side rendering\n- **TypeScript**: Type-safe JavaScript\n- **Tailwind CSS**: Utility-first CSS framework\n- **AWS SDK**: For S3 integration\n- **Docker/Kubernetes**: For containerization and orchestration\n\n### Project Structure\n\n- `/app`: Next.js application code\n- `/public`: Static assets\n- `/helm`: Kubernetes Helm chart\n- `/app/components`: React components\n- `/app/api`: API routes\n\n### Running Tests\n\n```bash\nnpm test\n```\n\n## 📜 License\n\nThis project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.\n\n## 🤝 Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcubbit%2Fslideshow-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcubbit%2Fslideshow-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcubbit%2Fslideshow-demo/lists"}