Giter VIP home page Giter VIP logo

ballerina-dev-kit's Introduction

Ballerina Development Kit

Build GitHub Last Commit Github issues

A set of tools and scripts designed for Developers working on Ballerina Lang related repositories.

Requirements

  • JDK 11
  • GNU Make 4.1+
  • Docker

How to Use

The make targets can be used to build ballerina pack and run the available test projects.

Getting Started

  1. Clone repository.
  2. Execute the following command to initialize and update all submodules.
    git submodule update --init --recursive

Building Ballerina Pack

The following make targets can be used to build a ballerina pack.

Make Target Description
ballerina-pack.build Build Ballerina Pack without using Gradle build cache
ballerina-pack.build.with-cache Build Ballerina Pack with Gradle build cache
ballerina-pack.build.in-place-update In place update the Ballerina pack

The ballerina pack should be available in <BALLERINA_DEV_KIT_ROOT>/packs directory once one of the above targets are executed.

Sample Test Projects

The following make targets can be used to build and run a test project.

Make Target Description
ballerina-project.<project>.build Build the
ballerina-project.<project>.build.debug Build the with remote debug
ballerina-project.<project>.run Run the
ballerina-project.<project>.run.debug Run the with remote debug

The following projects are available to be used along with the above targets and the <project> placeholder can be replaced with one of the following.

Project Make Target Placeholder Replacement
Hello World Service hello_world_service
Simple Passthrough simple_passthrough
Chained Ballerina Service chained_ballerina_service

Miscellaneous Tools

The following targets can be used to startup miscellaneous tools.

Make Target Description
misc.jaeger.start Start a Jaeger Server in a Docker Container
misc.prometheus.start Start a Prometheus Server in a Docker Container
misc.grafana.start Start a Grafana Server in a Docker Container

Contributions

This is meant to help any developers aiming to contribute to Ballerina. This project is not complete and can improve in many ways. Contributions to the Ballerina Development Kit are highly welcome.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.