# live-directory

> A Simple-To-Use Dynamic File Content Manager For Webservers

Latest version **3.0.3** (published 2023-02-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install live-directory
pnpm add live-directory
yarn add live-directory
bun add live-directory
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.3 |
| Published | 2023-02-13 |
| First published | 2021-05-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 22.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 15 |
| Author | kartikk221 |
| Maintainers | kartikk221 |
| Keywords | html-manager, template-manager, hot-reloading, reloading, webserver, template, manager, frontend, assets, watch, auto |

## Links

- npm: https://www.npmjs.com/package/live-directory
- Repository: https://github.com/kartikk221/live-directory
- Issues: https://github.com/kartikk221/live-directory/issues
- npm.io page: https://npm.io/package/live-directory

## Dependencies (1)

- [chokidar](https://npm.io/package/chokidar.md) ^3.5.2

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 3.0.3 (latest) — 2023-02-13
- 3.0.2 — 2023-01-25
- 3.0.1 — 2022-11-15
- 3.0.0 — 2022-11-15
- 2.3.2 — 2021-10-08
- 2.3.0 — 2021-09-27
- 2.2.0 — 2021-09-27
- 2.1.1 — 2021-09-27
- 2.1.0 — 2021-09-27
- 2.0.0 — 2021-09-26
- 1.1.0 — 2021-09-17
- 1.0.9 — 2021-09-15
- 1.0.8 — 2021-09-15
- 1.0.7 — 2021-09-10
- 1.0.6 — 2021-09-10
- … 6 more at https://npm.io/package/live-directory/versions

## README

# LiveDirectory: High Performance File Content Manager

<div align="left">

[![NPM version](https://img.shields.io/npm/v/live-directory.svg?style=flat)](https://www.npmjs.com/package/live-directory)
[![NPM downloads](https://img.shields.io/npm/dm/live-directory.svg?style=flat)](https://www.npmjs.com/package/live-directory)
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/kartikk221/live-directory.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/kartikk221/live-directory/context:javascript)
[![GitHub issues](https://img.shields.io/github/issues/kartikk221/live-directory)](https://github.com/kartikk221/live-directory/issues)
[![GitHub stars](https://img.shields.io/github/stars/kartikk221/live-directory)](https://github.com/kartikk221/live-directory/stargazers)
[![GitHub license](https://img.shields.io/github/license/kartikk221/live-directory)](https://github.com/kartikk221/live-directory/blob/master/LICENSE)

</div>

## 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]`](./docs/Examples.md) for small and **easy-to-use snippets** with LiveDirectory.
- See [`> [LiveDirectory]`](./docs/LiveDirectory.md) for creating and working with the **LiveDirectory** component.
- See [`> [LiveFile]`](./docs/LiveFile.md) 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.
1. Clone the LiveDirectory repository to your machine.
3. Run `npm install` in the root directory.
5. Run `npm test` to run all tests with your local changes.

## License
[MIT](./LICENSE)

---
_Source: https://npm.io/package/live-directory · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._