Repository files navigation

Please seeCONTRIBUTING to add your own custom Python nodes to Flojoy apps.

Please refer to the following link for installation guidelines:https://docs.flojoy.io/getting-started/install/

If you'd like to run Flojoy as an Electron app:

1. (Optional) Set the following env variables. These variables are used in thedocker-compose.yml file to set the image tags.Put any specific tag value if you need, otherwise Docker will use the latest by default.

BACKEND_IMAGE_TAG=latestRQ_WORKER_IMAGE_TAG=latestWATCH_IMAGE_TAG=latest

2. Runnpm run electron-dev to start Electron app locally. It will start the Docker containers to run the necessary backend parts.

To package the Electron app, runnpm run electron-package. Thedist folder will hold the generated artifacts.

Currently there are two CD workflows.

1. Base image CD: Builds and pushes the base image used inthe docker files.
2. CD: Runsi if a version tag is added. It builds packages, creates executables and creates github release with those artifacts.

The CD workflow is triggered when any change is pushed to any tag. So, to trigger it,

1. Tag a commit with v*.. pattern. For example :git tag v0.1.1
2. push the commit and tag :git push && git push --tags
3. The CD workflow will then run, generate artifacts and create draft release with those artifacts.
4. Go tohttps://github.com/flojoy-io/flojoy-desktop/releases to check the new draft release.

Flojoy is released under theAGPLv3 license. This is a copy-left license in the GPL family of licenses. As with allOSI approved licenses, there are no restrictions on what code licensed under AGPLv3 can be used for. However, the requirements for what must be shared publicly are greater than for licenses that are more commonly used in the Python ecosystem likeApache-2,MIT, andBSD-3.

The Flojoy copyright is owned by On-Scence Creative, and contributors are asked to sign a Contributor License Agreement (based on the Oracle CLA) that grants the company the non-exclusive right to re-license the contribution in the future. For example, the project could be re-licensed to one of the more permissive licenses above, or it could be dual licensed with a commercial license as a means to support the project.

If you might be interested in using Flojoy in a context where the AGPL license is prohibitive,please get in touch.