{"id":20656607,"url":"https://github.com/legend80s/gallery-server","last_synced_at":"2025-04-09T13:03:59.343Z","repository":{"id":46623989,"uuid":"217875745","full_name":"legend80s/gallery-server","owner":"legend80s","description":"Beautiful and powerful yet simple local image viewer on your PC or mobile.","archived":false,"fork":false,"pushed_at":"2024-12-04T01:24:38.000Z","size":6168,"stargazers_count":45,"open_issues_count":3,"forks_count":7,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-02T12:13:50.088Z","etag":null,"topics":["gallery","gallery-server","gallery-viewer","image-server","image-viewer"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/gallery-server","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/legend80s.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2019-10-27T15:32:06.000Z","updated_at":"2024-12-04T01:24:41.000Z","dependencies_parsed_at":"2025-01-16T07:11:37.433Z","dependency_job_id":"1a946f19-42a1-4b0c-a79a-36dce56cb850","html_url":"https://github.com/legend80s/gallery-server","commit_stats":{"total_commits":124,"total_committers":3,"mean_commits":"41.333333333333336","dds":"0.10483870967741937","last_synced_commit":"5d2c0bb3177d3fb47605d3addb66d3db03a85da1"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/legend80s%2Fgallery-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/legend80s%2Fgallery-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/legend80s%2Fgallery-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/legend80s%2Fgallery-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/legend80s","download_url":"https://codeload.github.com/legend80s/gallery-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248045230,"owners_count":21038553,"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":["gallery","gallery-server","gallery-viewer","image-server","image-viewer"],"created_at":"2024-11-16T18:16:34.365Z","updated_at":"2025-04-09T13:03:59.322Z","avatar_url":"https://github.com/legend80s.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003egallery-server 🖼️\u003c/h1\u003e\n\n\u003cp\u003e\n  \u003ca href=\"https://www.npmjs.com/package/gallery-server\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/gallery-server.svg\" alt=\"npm version\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/gallery-server\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/dm/gallery-server.svg\" alt=\"npm downloads\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://bundlephobia.com/result?p=gallery-server\"\u003e\n    \u003cimg src=\"https://flat.badgen.net/bundlephobia/minzip/gallery-server\" alt=\"Minified + gzip package size for gallery-server in KB\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/git-commit-msg-linter\"\u003e\n    \u003cimg src=\"https://badgen.net/badge/git-commit-msg-linter/3.2.5/green\" alt=\"commit msg linted by git-commit-msg-linter\" /\u003e\n  \u003c/a\u003e\n  \u003cimg src=\"https://visitor-badge.glitch.me/badge?page_id=legend80s/gallery-server\u0026left_color=blue\u0026right_color=green\" alt=\"visitor count\" /\u003e\n\u003c/p\u003e\n\n\u003cimg alt=\"demo-page-fullscreen\" src=\"https://raw.githubusercontent.com/legend80s/gallery-server/master/assets/demo-page-fullscreen.png\" width=\"100%\" /\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"gallery-mobile\" src=\"https://raw.githubusercontent.com/legend80s/gallery-server/master/assets/gallery-mobile.jpg\" width=\"40%\" /\u003e\n\u003c/p\u003e\n\n#### **\u003cp align=\"center\" style=\"color: #cb3837;\"\u003eBeautiful Local Image Viewer\u003c/p\u003e**\n\n\u003e Beautiful and powerful yet simple local image viewer on your PC or mobile.\n\n[中文版文档](https://juejin.cn/post/6973163233008058405/)\n\n## Install 🆓\n\nNo installment required!\n\n## Use 🌱\n\n1. Serve the local photos.\n\n```sh\nnpx gallery-server --folder /path/to/photos\n\n# for more usage\nnpx gallery-server -h\n```\n\n2. Open \u003chttp://localhost:xxxx/\u003e in your favorite browser or share with your friends \u003chttp://a.b.c.d:xxxx?token=${token}\u003e.\n\n### Enjoy on PC 💻\n\n![demo-page-album](https://raw.githubusercontent.com/legend80s/gallery-server/master/assets/demo-page-album-2.png)\n\n### Enjoy on Mobile Phone 📱\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"album-mobile\" src=\"https://raw.githubusercontent.com/legend80s/gallery-server/master/assets/album-mobile.jpeg\" width=\"40%\" /\u003e\n\u003c/p\u003e\n\n*Photos from pixabay API of Yosemite.*\n\n## Features 🌟\n\n1. 📱 Photos in your PC can be viewed in your mobile phone's browser! So your can download photos on your PC to mobile phone.\n2. 🔐 Security on privacy to prevent eavesdropping. API or images without token are forbidden, but you can still share with your friends by sending him the token.\n3. 🎭 Light and dark theme.\n4. 🎞️ Videos also supported!\n5. 🖼️ More than one galleries can be served at the same time.\n6. 📚 A lot of gallery features. Check it at [react-images](https://jossmac.github.io/react-images/#/accessibility).\n\n## FAQ 🙋‍♂️\n\n1. Q: Why `403 forbidden`？\n\n   ```json\n   {\n     \"code\": 403,\n     \"message\": \"Forbidden. `token` required. Please redirect to https://github.com/legend80s/gallery-server#faq for more information.\"\n   }\n   ```\n\n   - A: You see this message because you are not the gallery owner. Ask the owner for the token and append it to the resource URL.\n\n2. Photos in node_modules will be ignored for performance.\n\n## Develop 👨‍💻\n\n1. start api server\n\n```sh\nnpm run dev:server -- --folder=/path/to/photos\n```\n\n2. start webpack devServer\n\n```sh\nnpm run dev:client\n```\n\nNotice: Install all the dependencies into `./package.json`'s devDependencies not `./client/package.json`. The package.json in `client` exits only for `scripts`。\n\nFor example if you want change to another gallery (react-bnb-gallery):\n\n```sh\n# enter project root not ./client/\ncd project_root\n\nnpm install --save-dev react-bnb-gallery\n\n# start api server\nnpm run dev:server -- --folder=/path/to/photos\n\n# start webpack devServer\nnpm run dev:client\n```\n\n## Publish 📦\n\n```sh\nnpm version patch / minor / major\n```\n\n## Run tests 🧪\n\n```sh\nnpm run test\n```\n\n## Author 👤\n\n👤 **legend80s**\n\n- Github: [@legend80s](https://github.com/legend80s)\n\n## 🤝 Contributing\n\nContributions, issues and feature requests are welcome!\n\nFeel free to check [issues page](https://github.com/legend80s/gallery-server/issues).\n\n## Todos ☑️\n\n- [x] Any port. use unoccupied port.\n- [ ] Build with remote client to support a wide range of client gallery.\n- [x] Use network IP. mimic create-react-app.\n- [x] Show help Information on cli `-v` `-h`.\n- [x] Viewable on mobile.\n- [x] Adapt to mobile.\n- [ ] Image lazy load.\n- [x] Security on privacy. only url with token is shareable.\n- [x] Port customizable.\n- [x] Token customizable.\n- [x] Serve multiple folders in one cmd.\n- [x] Token can be optional when viewed on owner's brower.\n- [ ] Electron App.\n\n## Show your support ⭐️\n\nGive a ⭐️ if this project helped you!\n\n***\n*This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flegend80s%2Fgallery-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flegend80s%2Fgallery-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flegend80s%2Fgallery-server/lists"}