Sparkle's Guide is inspired by roadmap.sh and is a derivative open source work of node-red. This project aims to be a guide to sparkles and unicorns in the blessing on their magical journey to better themselves and each other.

Quick Start

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.

npm install
npm run build
npm start -- data/flows.json
Open http://127.0.0.1:1880/

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. The Homebrew formula for installing podman on a Mac can be found here.

./container-build.sh
./container-run.sh
Open http://127.0.0.1:1880/

Contributing

Submit an issue if unsure.

To Sparkle Guides

See this guide, if you are looking to contribute to the guides and flows.

To Code

See this guide, if you are looking to add/remove/modify code implementing Sparkle's Guide.

Copyright and license

Copyright OpenJS Foundation and other contributors, https://openjsf.org under the Apache 2.0 license.
December 2021 --- this project and modifications within it are a derivative work of node-red