From 80fdd93d239dab942f00334a64b814d82ade3ec4 Mon Sep 17 00:00:00 2001 From: Gavin Scallon Date: Thu, 24 Feb 2022 08:15:12 -0700 Subject: [PATCH] Added prereq information for installing npm and docker/podman. Added some supplemental info for less experienced Unicorns. --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5f090049d..da2557651 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,26 @@ Sparkle's Guide is inspired by [roadmap.sh](https://roadmap.sh) and is a derivative open source work of [node-red](https://github.com/node-red/node-red). This project aims to be a guide to sparkles and unicorns in the [blessing](https://unicornyard.com/what-is-a-group-of-unicorns-called/) on their magical journey to better themselves and each other. ## Quick Start -Local Environment with NPM + +Begin by cloning the Sparkles-Guide repository to the machine using SSH (`git clone git@github.com:defenseunicorns/Sparkles-Guide.git`) or HTTPS (`git clone https://github.com/defenseunicorns/Sparkles-Guide.git`). + +After the project has been cloned, run `cd ./Sparkles-Guide` in the terminal in order to change the current working directory to the top level of the project to run the Quick Start commands as shown. + +There are two different methods that can be used in order to get the Sparkle's Guide up-and-running quickly once the project has been cloned: + +### Local Environment with NPM + +Prerequisite: Ensure that node and npm are installed on the machine. [This article provides information on installing both on Mac using Homebrew](https://medium.com/@hayasnc/how-to-install-nodejs-and-npm-on-mac-using-homebrew-b33780287d8f). + 1. `npm install` 2. `npm run build` 3. `npm start -- data/flows.json` 4. Open -Docker/Podman +### Docker/Podman + +Prerequisite: Ensure that docker or podman are installed on the machine. [This article provides information on installing Docker on Mac using Docker Desktop/Homebrew](https://www.cprime.com/resources/blog/docker-for-mac-with-homebrew-a-step-by-step-tutorial/). The Homebrew formula for [installing podman on a Mac can be found here](https://formulae.brew.sh/formula/podman). + 1. `./container-build.sh` 2. `./container-run.sh` 3. Open