Files
visualtree/README.md
2021-12-29 11:20:16 -06:00

57 lines
1.3 KiB
Markdown

<div id="top"></div>
<!-- PROJECT LOGO -->
<br />
<div align="center">
<h3 align="center">VisualTree</h3>
<img src="https://user-images.githubusercontent.com/30842498/147685192-7071225f-34bf-46fb-9c3f-a00f946addd8.png" alt="Preview" >
<p align="center">
A tool that allows you to visualize and interact with the output of your tree command.
<br />
<a href="https://visualtree.xyvs.io">View Demo</a>
</p>
</div>
<!-- ABOUT THE PROJECT -->
## About The Project
This tool allows you to interact with the output of you tree command, which is pretty useful in case you want to archive your file structure at some point and be able to interact with it later.
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Getting Started
To get a local copy up and running follow these simple example steps.
### Installation
1. Clone the repo
```sh
git clone https://github.com/xyvs/visualtree.git
```
2. Install NPM packages
```sh
npm install
```
3. Run the server
```sh
npm run dev
```
4. Go to [localhost:3000](https://localhost:3000)
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- LICENSE -->
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
<p align="right">(<a href="#top">back to top</a>)</p>