/beagle

A framework to help implement Server-Driven UI in your apps natively.

Primary LanguageShellApache License 2.0Apache-2.0

Table of contents

2.3 Usage

About

Beagle is an open-source framework for cross-platform development using the concept of Server-Driven UI.

This framework allows teams to build and alter layouts and data directly through a backend but yet displaying its contents natively in a mobile application and/or through a web one.

You can also create, test and update native application components and screen paths without updating the mobile application at the store (App Store or Play Store).

Getting started

Requirements

  • Beagle apps may target iOS 10.0 and Android 4.4 (API 19) or newer.
  • You may use Windows, macOS, or Linux as your development operating system.

Installation

The recommended way to install Beagle depends on your project. Follow the Getting Started guide:

Usage

Building your first app using Beagle

You can find short guides for the most common scenarios:

Documentation

You can find Beagle's documentation on our website. Beagle's documentation discusses components, APIs, and topics that are specific to Beagle.

Contributing

The main purpose of this repository is to continue evolving Beagle core. We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing to bug fixes and improvements.

Check out our Contributing Guide to learn about our development process, how to suggest bugfixes and improvements.

Developer Certificate of Origin - DCO

This is a security layer for the project and for the developers. It is mandatory.

Follow one of these two methods to add DCO to your commits:

1. Command line Follow the steps: Step 1: Configure your local git environment adding the same name and e-mail configured at your GitHub account. It helps to sign commits manually during reviews and suggestions.

git config --global user.name “Name”
git config --global user.email “email@domain.com.br”

Step 2: Add the Signed-off-by line with the '-s' flag in the git commit command:

$ git commit -s -m "This is my commit message"

2. GitHub website You can also manually sign your commits during GitHub reviews and suggestions, follow the steps below:

Step 1: When the commit changes box opens, manually type or paste your signature in the comment box, see the example:

Signed-off-by: Name < e-mail address >

For this method, your name and e-mail must be the same registered on your GitHub account.

Projects

Beagle has a repository for each one of our projects. Check them below:

Code of Conduct

Please follow the Code of Conduct in all your interactions with our project

License

Apache License 2.0.

Community

  • Do you have any question about Beagle? Let's chat in our forum.