frodovdr/node-red
1
0
Fork 0
mirror of https://github.com/node-red/node-red.git synced 2025-03-01 10:36:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added prereq information for installing npm and docker/podman. Added some supplemental info for less experienced Unicorns.

Browse Source
This commit is contained in:
Gavin Scallon 2022-02-24 08:15:12 -07:00 committed by andrew.greene
parent 16c19af7d6
commit 80fdd93d23
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -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. 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 ## 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` 1. `npm install`
2. `npm run build` 2. `npm run build`
3. `npm start -- data/flows.json` 3. `npm start -- data/flows.json`
4. Open <http://127.0.0.1:1880/> 4. Open <http://127.0.0.1:1880/>
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` 1. `./container-build.sh`
2. `./container-run.sh` 2. `./container-run.sh`
3. Open <http://127.0.0.1:1880/> 3. Open <http://127.0.0.1:1880/>