jakeburden / PhotoSwipe

JavaScript image gallery for mobile and desktop, modular, framework independent.

PhotoSwipe Repository

JavaScript image gallery for mobile and desktop.

• Documentation and getting started guide.
• Demo and plugin home page.

Optionally, install via Bower: bower install photoswipe.

Location of stuff

• Generated popup JS, CSS files, SVG & PNG sprites are in folder dist/.
• Source files are in folder src/.
• Website (examples & documentation) is in folder website/.
• Documentation page itself is in website/documentation.md.

Plugins or extensions

Wrote a plugin for some CMS? Email me and I'll post link to it here.

Build

To compile PhotoSwipe by yourself, first of make sure that you have Node.js, Grunt.js, Ruby and Jekyll installed, then:

1. Copy repository

   git clone https://github.com/dimsemenov/PhotoSwipe.git

2. Go inside PhotoSwipe folder that you fetched and install Node dependencies

   cd PhotoSwipe && npm install

3. Now simply run grunt to generate JS and CSS in folder dist and site in folder _site/.

   grunt

Optionally:

• Run grunt watch to automatically rebuild script when you change files in src/ or in website/.
• If you don't have and don't want to install Jekyll, run grunt nosite to just build JS and CSS files related to popup in dist/.

Using PhotoSwipe?

If you used PhotoSwipe in some interesting way, or on site of popular brand, I'd be very grateful if you shoot me a link to it.

License

Script is licensed under MIT license with one exception: Do not create a public WordPress plugin based on it, as I will develop it. If you need to use it for a public WordPress plugin right now, please ask me by email first. Thanks!

Attribution is not required, but much appreciated, especially if you're making product for developers.

About

The script was created by Code Computerlove, a digital agency in Manchester. In March 2014, it passed on development to Dmitry Semenov.