README
¶
Serverless functions and edge microservices made painless
Getting Started | Documentation | Contributing | License
Project Flogo is an open source framework to simplify building efficient & modern serverless functions and edge microservices and this repository is the core library used to create and extend those Flogo Applications.
Flogo Core
Flogo Core is the core flogo library which contains the apis to create and extend Flogo applications.
Getting started
If you want to get started with Project Flogo, you should install the install the Flogo CLI. You can find details there on creating a quick sample application. You also might want to check out the getting started guide in our docs or check out the Labs section in our docs for in depth tutorials.
Documentation
Here is some documentation to help you get started understanding some of the fundamentals of the Flogo Core library.
- Model: The Flogo application model
- Data Types: The Flogo data types
- Mapping: Mapping data in Flogo applications
In addition to low-level APIs used to support and run Flogo applications, the Core library contains some high-level APIs. There is an API that can be used to programmatically create and run an application. There are also interfaces that can be implemented to create your own Flogo contributions, such as Triggers and Activities.
- Application: API to build and execute a Flogo application
- Contributions: APIs and interfaces for Flogo contribution development
Contributing
Want to contribute to Project Flogo? We've made it easy, all you need to do is fork the repository you intend to contribute to, make your changes and create a Pull Request! Once the pull request has been created, you'll be prompted to sign the CLA (Contributor License Agreement) online.
Not sure where to start? No problem, you can browse the Project Flogo repos and look for issues tagged kind/help-wanted or good first issue. To make this even easier, we've added the links right here too!
- Project Flogo: kind/help-wanted and good first issue
- flogo cli: kind/help-wanted and good first issue
- flogo core: kind/help-wanted and good first issue
- flogo contrib: kind/help-wanted and good first issue
Another great way to contribute to Project Flogo is to check flogo-contrib. That repository contains some basic contributions, such as activities, triggers, etc. Perhaps there is something missing? Create a new activity or trigger or fix a bug in an existing activity or trigger.
If you have any questions, feel free to post an issue and tag it as a question, email flogo-oss@tibco.com 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.
For additional details, refer to the Contribution Guidelines.
License
Flogo source code in this repository is under a BSD-style license, refer to LICENSE
Directories