Beagle

Getting Started · Learn the Basics · Contribute

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

This framework allow 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 web.

It is also possible to create, test and update native application components and screen paths without the need update the mobile application at the store (App Store or Play Store).

Contents

• Requirements
• Building your first app using Beagle
• Documentation
• How to Contribute
• Code of Conduct
• License

📋 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.

🎉 Building your first app using Beagle

Follow the Getting Started guide. The recommended way to install Beagle depends on your project. Here you can find short guides for the most common scenarios:

• Creating a New Application
• Adding Beagle to an Existing Application

📖 Documentation

The full documentation for Beagle can be found on our website.

The Beagle documentation discusses components, APIs, and topics that are specific to Beagle. Beagle documentation.

👏 How to Contribute

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 bug fixes and improvements. Read below to learn how you can take part in improving Beagle.

Contributing Guide

Read our Contributing Guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Beagle.

Code of Conduct

Beagle has adopted a Code of Conduct that we expect project participants to adhere to. Please read the code so that you can understand what actions will and will not be tolerated.

Open Source Roadmap

You can learn more about our vision for beagle in the Roadmap.

Good First Issues

We have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.

📄 License

Beagle is Apache 2.0 licensed, as found in the LICENSE file.