core

Serverless functions and edge microservices made painless

Getting Started | Documentation | Contributing | License

Project Qodeflow 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 Qodeflow Applications.

Qodeflow Core

Qodeflow Core is the core qodeflow library which contains the apis to create and extend Qodeflow applications.

Getting started

If you want to get started with Project Qodeflow, you should install the install the Qodeflow 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 Qodeflow Core library.

• Model: The Qodeflow application model
• Data Types: The Qodeflow data types
• Mapping: Mapping data in Qodeflow applications

In addition to low-level APIs used to support and run Qodeflow 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 Qodeflow contributions, such as Triggers and Activities.

• Application: API to build and execute a Qodeflow application
• Contributions: APIs and interfaces for Qodeflow contribution development

Contributing

Want to contribute to Project Qodeflow? 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 Qodeflow 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 Qodeflow: kind/help-wanted and good first issue
• qodeflow cli: kind/help-wanted and good first issue
• qodeflow core: kind/help-wanted and good first issue
• qodeflow contrib: kind/help-wanted and good first issue

Another great way to contribute to Project Qodeflow is to check qodeflow-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 qodeflow-oss@tibco.com or chat with the team and community:

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

For additional details, refer to the Contribution Guidelines.

License

Qodeflow source code in this repository is under a BSD-style license, refer to LICENSE