search

kartikk221 / live-directory

A Simple-To-Use Dynamic Template Content Manager For Webservers
MIT License
12 stars 5 forks source link

readme

LiveDirectory: High Performance File Content Manager

[![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)

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

Documentation

LiveDirectory can be installed using Node Package Manager (npm).

npm i live-directory

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.
  2. Run npm install in the root directory.
  3. Run npm test to run all tests with your local changes.

License

MIT