https://github.com/legend80s/gallery-server
Beautiful and powerful yet simple local image viewer on your PC or mobile.
https://github.com/legend80s/gallery-server
gallery gallery-server gallery-viewer image-server image-viewer
Last synced: about 2 months ago
JSON representation
Beautiful and powerful yet simple local image viewer on your PC or mobile.
- Host: GitHub
- URL: https://github.com/legend80s/gallery-server
- Owner: legend80s
- Created: 2019-10-27T15:32:06.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-04T01:24:38.000Z (6 months ago)
- Last Synced: 2025-04-02T12:13:50.088Z (about 2 months ago)
- Topics: gallery, gallery-server, gallery-viewer, image-server, image-viewer
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/gallery-server
- Size: 5.88 MB
- Stars: 45
- Watchers: 3
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
gallery-server πΌοΈ
#### **
Beautiful Local Image Viewer
**
> Beautiful and powerful yet simple local image viewer on your PC or mobile.
[δΈζηζζ‘£](https://juejin.cn/post/6973163233008058405/)
## Install π
No installment required!
## Use π±
1. Serve the local photos.
```sh
npx gallery-server --folder /path/to/photos
# for more usage
npx gallery-server -h
```
2. Open in your favorite browser or share with your friends .
### Enjoy on PC π»
### Enjoy on Mobile Phone π±
*Photos from pixabay API of Yosemite.*
## Features π
1. π± Photos in your PC can be viewed in your mobile phone's browser! So your can download photos on your PC to mobile phone.
2. π 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.
3. π Light and dark theme.
4. ποΈ Videos also supported!
5. πΌοΈ More than one galleries can be served at the same time.
6. π A lot of gallery features. Check it at [react-images](https://jossmac.github.io/react-images/#/accessibility).
## FAQ πββοΈ
1. Q: Why `403 forbidden`οΌ
```json
{
"code": 403,
"message": "Forbidden. `token` required. Please redirect to https://github.com/legend80s/gallery-server#faq for more information."
}
```
- 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.
2. Photos in node_modules will be ignored for performance.
## Develop π¨βπ»
1. start api server
```sh
npm run dev:server -- --folder=/path/to/photos
```
2. start webpack devServer
```sh
npm run dev:client
```
Notice: Install all the dependencies into `./package.json`'s devDependencies not `./client/package.json`. The package.json in `client` exits only for `scripts`γ
For example if you want change to another gallery (react-bnb-gallery):
```sh
# enter project root not ./client/
cd project_root
npm install --save-dev react-bnb-gallery
# start api server
npm run dev:server -- --folder=/path/to/photos
# start webpack devServer
npm run dev:client
```
## Publish π¦
```sh
npm version patch / minor / major
```
## Run tests π§ͺ
```sh
npm run test
```
## Author π€
π€ **legend80s**
- Github: [@legend80s](https://github.com/legend80s)
## π€ Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/legend80s/gallery-server/issues).
## Todos βοΈ
- [x] Any port. use unoccupied port.
- [ ] Build with remote client to support a wide range of client gallery.
- [x] Use network IP. mimic create-react-app.
- [x] Show help Information on cli `-v` `-h`.
- [x] Viewable on mobile.
- [x] Adapt to mobile.
- [ ] Image lazy load.
- [x] Security on privacy. only url with token is shareable.
- [x] Port customizable.
- [x] Token customizable.
- [x] Serve multiple folders in one cmd.
- [x] Token can be optional when viewed on owner's brower.
- [ ] Electron App.
## Show your support βοΈ
Give a βοΈ if this project helped you!
***
*This README was generated with β€οΈ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)*