https://github.com/idleberg/bootstrap-listr
Beautiful, responsive directory listings built upon Bootstrap
https://github.com/idleberg/bootstrap-listr
directoryindex file-viewer viewer
Last synced: about 1 month ago
JSON representation
Beautiful, responsive directory listings built upon Bootstrap
- Host: GitHub
- URL: https://github.com/idleberg/bootstrap-listr
- Owner: idleberg
- License: mit
- Archived: true
- Created: 2013-09-11T20:02:37.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2022-11-11T21:05:26.000Z (over 2 years ago)
- Last Synced: 2025-04-27T10:04:54.409Z (about 1 month ago)
- Topics: directoryindex, file-viewer, viewer
- Language: PHP
- Homepage:
- Size: 1.91 MB
- Stars: 222
- Watchers: 22
- Forks: 46
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Bootstrap Listr
[](http://opensource.org/licenses/MIT)
[](https://github.com/idleberg/Bootstrap-Listr/releases)
[](https://travis-ci.org/idleberg/Bootstrap-Listr)
[](https://david-dm.org/idleberg/Bootstrap-Listr#info=dependencies)
[](https://david-dm.org/idleberg/Bootstrap-Listr?type=dev)
A replacement for default server indices, Bootstrap Listr beautifully displays folders and files in the browser. It is built upon the [Bootstrap](http://getbootstrap.com) framework and [Font Awesome](http://fortawesome.github.io/Font-Awesome/) icons, optionally [Bootswatch](http://bootswatch.com/) themes can be used.
## Installation
Download the [latest release](https://github.com/idleberg/Bootstrap-Listr/releases/latest) or clone the repository.
## Building
We use [Gulp](http://gulpjs.com/) tasks to configure and build your application. Make sure to have gulp installed globally as well as all local Node dependencies.
```bash
# 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:
```bash
# 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](https://github.com/idleberg/Bootstrap-Listr/wiki/Understanding-config.json) for details.
## Support
It's always a good start to consult the [FAQ](https://github.com/idleberg/Bootstrap-Listr/wiki/FAQ) or the [project wiki](https://github.com/idleberg/Bootstrap-Listr/wiki) in general.
### Issues
Report issue or suggest new features only on [GitHub](https://github.com/idleberg/Bootstrap-Listr/issues)!
### 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](https://gitter.im/idleberg/Bootstrap-Listr) channel.
## Credits
This project is built upon—or includes—code from the following people:
* Greg Johnson - [PHPDL lite](http://web.archive.org/web/20130920165711/http://greg-j.com/phpdl/) [Internet Archive]
* Na Wong - [Listr](http://nadesign.net/listr/)
Contributors:
* [@melalj](https://github.com/melalj) - subfolder support
* [@Zerquix18](https://github.com/Zerquix18) - security fixes
## License
This work is licensed under the [The MIT License](LICENSE.md).