darkblaez/flogo-web

Project Flogo Web UI

Flogo Web UI

Web-based design tool for the Project Flogo open source framework.

Using the Web UI

The easiest way to get started with the Flogo Web UI is via the official Docker image. The Docker image is available in Docker Hub and it contains the Flogo Web UI along with all required components to begin developing, testing and building deployable artifacts right from your web browser.

You can find a more complete start guide for the official Docker image in the Project Flogo documentation.

Issues, Bug Reports and Feature Requests

Check out our issue tracker.

If you have any questions, feel free to post an issue and tag it as a question, email [email protected] or chat with the team and community:

• The project-flogo/Lobby Gitter channel should be used for general discussions, start here for all things Flogo!
• The project-flogo/developers Gitter channel should be used for developer/contributor focused conversations.

Contributing

Thanks for your interest in contributing! There are many ways to contribute to this project. Get started here CONTRIBUTING.md

Development

The recommended method is to run the app locally which is going to be easier for debugging as well as it is going to watch for code changes and reload automatically, alternatively you can build your own docker image.

Run locally

Before starting make sure you have the following installed in your machine:

• git
• Latest Flogo CLI (flogo-cli)
• As part of the Flogo CLI installation process you should've also installed the Go programming language. Make sure you added $GOPATH/bin to your $PATH variable. Instructions can be found in Go's installation docs
• Docker and docker-compose 17.12.0 or greater
• NodeJS 10.14 or greater
• yarn v1.9.4 or greater

Let's bootstrap the project, in a terminal run the following:

# Get the Flogo Web UI source from GitHub
git clone https://github.com/project-flogo/flogo-web.git

# Go to the directory
cd flogo-web

# Install the javascript dependencies
yarn install

From here we're going to need two terminals, one to run the server application and another one for the client app:

# in terminal 1 run:
yarn start server

# in terminal 2 run:
yarn start client

☕ Please be patient if this is the first time you run the server app as it can take several minutes to finish the startup process because the server app will need to create a Flogo engine instance and install the default activities and triggers.

Once both applications finish their startup process open http://localhost:4200 to start using the Flogo Web UI!

Example of server output

 ======================================================
                 ___       __   __   __ TM
                |__  |    /  \ / _` /  \
                |    |___ \__/ \__| \__/

   [success] open http://localhost:3303 in your browser
  ======================================================

Example of client output

❯ yarn start client
yarn run v1.9.4
$ ng serve client
** Angular Live Development Server is listening on localhost:4200, open your browser on http://localhost:4200/ **
                                                           s Date: 2019-04-01T22:09:22.196Z
Hash: 4ef21db4aa063e7aa9a9
Time: 22777ms
chunk {app-app-module} app-app-module.js, app-app-module.js.map (app-app-module) 370 kB  [rendered]
chunk {config-config-module} config-config-module.js, config-config-module.js.map (config-config-module) 16.2 kB  [rendered]
chunk {flogo-web-plugins-flow-client} flogo-web-plugins-flow-client.js, flogo-web-plugins-flow-client.js.map (flogo-web-plugins-flow-client) 1.58 MB  [rendered]
chunk {home-home-module} home-home-module.j

Building and running the development docker image

Before starting make sure you have Docker installed and then from a terminal run:

# Get the Flogo Web UI source from GitHub
git clone https://github.com/project-flogo/flogo-web.git

# Go to the directory
cd flogo-web

# Build the docker image
# Note that depending on your machine resources this might take several minutes
docker build -f tools/docker/dev.Dockerfile -t flogo/flogo-web:dev-build .

# Start the container
docker run -it -p 5033:3303 flogo/flogo-web:dev-build

You can navigate to http://localhost:5033 once the container starts. Note that you can change the port 5033 in the command to a different port if needed.

Plugins Documentation

Available in /docs/plugins

More docs?

Available in /docs

License

The flogo-web repo is licensed under a BSD-style license. Refer to LICENSE for license text.