Beautiful, responsive directory listings built upon Bootstrap
PHP JavaScript CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github update description Dec 29, 2016
src version bump Mar 13, 2017
tasks exclude file Feb 7, 2017
.bowerrc update file Jul 4, 2015
.gitignore add support for yarn Jan 18, 2017
.scss-lint.yml first commit Jan 26, 2016
.travis.yml add support for yarn Jan 18, 2017
Dockerfile Added Dockerfile Aug 12, 2016
LICENSE.md Update copyright-year Jan 2, 2018
README.md long gone Jan 10, 2017
bower.json version bump Mar 13, 2017
gulpfile.js use const Oct 6, 2016
package.json version bump Apr 14, 2017
yarn.lock update devDependencies Mar 6, 2017

README.md

Bootstrap Listr

The MIT License GitHub release Travis David David

A replacement for default server indices, Bootstrap Listr beautifully displays folders and files in the browser. It is built upon the Bootstrap framework and Font Awesome icons, optionally Bootswatch themes can be used.

Watch a live demo (latest alpha-version!)

Installation

Download the latest release or clone the repository.

Building

We use Gulp tasks to configure and build your application. Make sure to have gulp installed globally as well as all local Node dependencies.

# Install Gulp (optional)
npm install -g gulp

# Install dependencies
yarn || npm install

You can now run the build script to create a clean copy of Bootstrap Listr:

# Concatenated assets
npm run build

# Individual assets
npm run build:http2

Alternatively, you can now run the individual Gulp tasks. See gulp help for a list of available tasks.

Deployment

Deploy build/ to your server. All files that should be accessible in the browser go into the _public folder (you can define a different folder in the config.json). Depending on your Apache settings, you might have to uncomment the RewriteBase setting in the .htaccess file (maybe add folder name after the slash.)

Options

You can configure a number of settings in the file config.json:

  • Optional columns for size and modified date
  • Document icons
  • File viewer for images, videos, audio, source code, PDF and HTML
  • Search box to filter results
  • Column sorting
  • Responsive tables
  • List of ignored files
  • List of hidden files
  • Default location for JavaScript libraries and style sheets (CDN or local)
  • Syntax highlighting in file viewer
  • Save to Dropbox
  • Share buttons
  • Google Analytics
  • Language
  • Virtual files

Please visit the project wiki for details.

Support

It's always a good start to consult the FAQ or the project wiki in general.

Issues

Report issue or suggest new features only on GitHub!

Contribute

To contribute patches, follow this standard procedure:

  1. Fork the repository
  2. Make your changes to the development branch
  3. Communicate your changes
  4. Send a pull request with your changes

Talk

For user specific problems or just to have a chat with the developers, feel free to join our Gitter channel.

Credits

This project is built upon—or includes—code from the following people:

Contributors:

License

This work is licensed under the The MIT License.

Donate

You are welcome support this project using Flattr or Bitcoin 17CXJuPsmhuTzFV2k4RKYwpEHVjskJktRd