node-red/docs/code-contribution.md
Jordan McClintock f093ef1bb1
docs update
2022-02-23 15:39:24 -06:00

20 lines
835 B
Markdown

# Code Contribution
Sparkles guide is forked from Node-red, which has a LOT of functionality in addition to the nice UI we use. As such, much code is not relevant for our purpose.
Since this is a derivative work, using an Apache 2.0 license. We MUST add a modification copyright to any changed files not originated by us. Add `2022 Modification Copyright - Defense Unicorns` as a comment to the top of any changed file.
Finally, deleting code often has unintended consequences - you should, at a minimum, add cypress tests to confirm basic, common functionality to ensure functionality.
## Running the code
1. `npm install`
2. `npm run dev` # auto load code changes
3. open <https://127.0.0.1:1880>
## Testing code
1. `npm run dev -- data/flows.json` or `npm start -- data/flows.json`
2. `npm run cy:run` # Runs cypress tests