live-directory
v3.0.3
Published
A Simple-To-Use Dynamic File Content Manager For Webservers
Downloads
2,131
Maintainers
Readme
LiveDirectory: High Performance File Content Manager
Motivation
Implementing your own template / file management system which consistently reads and updates file content can be tedious. LiveDirectory aims to solve that by acting as an automated file content store making a directory truly come alive. Powered by the efficient file watching library chokidar, LiveDirectory can be an efficient solution for fast and iterative web development.
Features
- Etag Support
- Memory Efficient
- Simple-to-use API
- Sub-Directory Support
- Asynchronous By Nature
- Instantaneous Hot Reloading
- Supports Windows, Linux & MacOS
Documentation
LiveDirectory can be installed using Node Package Manager (npm
).
npm i live-directory
- See
> [Examples & Snippets]
for small and easy-to-use snippets with LiveDirectory. - See
> [LiveDirectory]
for creating and working with the LiveDirectory component. - See
> [LiveFile]
for working with loaded files from live directory instances.
Testing Changes
To run LiveDirectory functionality tests locally on your machine, you must follow the steps below.
- Clone the LiveDirectory repository to your machine.
- Run
npm install
in the root directory. - Run
npm test
to run all tests with your local changes.