README.md

urban-tree / server

NodeJS tree file explorer server for urban-tree

Get Started

Clone Repository

Fortunately, the client is packaged in the same repository as the ubran-tree project. So, you won't need to make any additional cloning. But you'll need to change the directory to the frontend client.

cd server

Install Dependencies

We're already using the node version manager rc file from the parent directory, so we'll just install the necessary dependencies.

npm install

Run the Server

We've added a script that will help you run the server instantly.

But when running the server, you'll want to add the path to the directories you want to observe, so make sure you include them as parameters as shown below.

npm run deploy <path-1> <path-2> <path-3> ...

In case you'd like to learn more about the scripts available, you can find them here

Miscellaneous

Package Scripts

script	description
build	compiles typescript code to javascript
clean	deletes the javascript code generated by last build
rebuild	runs the clean script followed by the build script
start	starts the node js server (without building)
deploy	runs the build script followed by the start script
lint	runs eslint against the typescript code
debug	runs the deploy script in debugging mode