mirror of
https://github.com/node-red/node-red.git
synced 2025-03-01 10:36:34 +00:00
34 lines
1.5 KiB
Markdown
34 lines
1.5 KiB
Markdown
# A Sparkle's Guide to Glitter
|
|
> To shine your [alicorn](Phttps://www.merriam-webster.com/dictionary/alicorn) and make it glitter, a [sparkle](https://twitter.com/andyerikson/status/655496264482758660?lang=en) must embrace their destiny
|
|
|
|
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
|
|
1. `npm install`
|
|
2. `npm run build`
|
|
3. `npm start -- data/flows.json`
|
|
4. Open <http://127.0.0.1:1880/>
|
|
|
|
Docker/Podman
|
|
1. `./container-build.sh`
|
|
2. `./container-run.sh`
|
|
3. Open <http://127.0.0.1:1880/>
|
|
|
|
## Contributing
|
|
|
|
Submit an [issue](https://github.com/defenseunicorns/Sparkles-Guide/issues/new) if unsure.
|
|
|
|
### To Sparkle Guides
|
|
|
|
See [this](docs/sparkles-guides-contribution.md) guide, if you are looking to contribute to the guides and flows.
|
|
|
|
### To Code
|
|
|
|
See [this](docs/code-contribution.md) 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](LICENSE).
|
|
December 2021 --- this project and modifications within it are a derivative work of [node-red](https://github.com/node-red/node-red)
|