From 3149bf8b9562521015c17cda12d2b13e35cc9614 Mon Sep 17 00:00:00 2001 From: Ben West Date: Thu, 18 Feb 2021 10:02:00 -0800 Subject: [PATCH] task: clean project root setup.sh appears to be a developer utility to assist in bootstrapping a debian based system. It is intended to help install the dependencies needed to run node, and not used in any automated deploy pipeline. Instructions have been updated to suite this change which simply moves the developer tool out of the project repo and into the bin subdirectory. --- README.md | 6 +++--- setup.sh => bin/setup.sh | 0 2 files changed, 3 insertions(+), 3 deletions(-) rename setup.sh => bin/setup.sh (100%) diff --git a/README.md b/README.md index cbaecb5f..767d954e 100644 --- a/README.md +++ b/README.md @@ -164,7 +164,7 @@ Some features may not work with devices/browsers on the older end of these requi ## Windows installation software requirements: -- [Node.js](http://nodejs.org/) Latest Node 12 LTS. Node versions that do not have the latest security patches will not work. Use [Install instructions for Node](https://nodejs.org/en/download/package-manager/) or use `setup.sh`) +- [Node.js](http://nodejs.org/) Latest Node 12 LTS. Node versions that do not have the latest security patches will not work. Use [Install instructions for Node](https://nodejs.org/en/download/package-manager/) or use `bin/setup.sh`) - [MongoDB](https://www.mongodb.com/download-center?jmp=nav#community) 3.x or later. MongoDB 2.4 is only supported for Raspberry Pi. As a non-root user clone this repo then install dependencies into the root of the project: @@ -690,13 +690,13 @@ Your hosting provider probably has a way to set these through their GUI. ### Vagrant install Optionally, use [Vagrant](https://www.vagrantup.com/) with the -included `Vagrantfile` and `setup.sh` to install OS and node packages to +included `Vagrantfile` and `bin/setup.sh` to install OS and node packages to a virtual machine. ```bash host$ vagrant up host$ vagrant ssh -vm$ setup.sh +vm$ ./bin/setup.sh ``` The setup script will install OS packages then run `npm install`. diff --git a/setup.sh b/bin/setup.sh similarity index 100% rename from setup.sh rename to bin/setup.sh