https://github.com/ZupIT/beagle

A framework to help implement Server-Driven UI in your apps natively.
https://github.com/ZupIT/beagle

android hacktoberfest ios server-driven-ui

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/ZupIT/beagle
• Owner: ZupIT
• License: apache-2.0
• Archived: true
• Created: 2020-03-31T15:22:47.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-02-06T12:17:23.000Z (almost 2 years ago)
• Last Synced: 2024-07-19T05:15:25.214Z (4 months ago)
• Topics: android, hacktoberfest, ios, server-driven-ui
• Language: Shell
• Homepage: https://docs.usebeagle.io
• Size: 11.8 MB
• Stars: 689
• Watchers: 78
• Forks: 90
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        



  





  

    Beagle

  





  Getting Started

   · 

  Learn the Basics

   · 

  Contribute



## **Table of contents**

### 1. [**About**](#about)

### 2. [**Getting started**](#getting-started)

>#### 2.1. [**Requirements**](#requirements)

>#### 2.2 [**Installation**](#installation)

### 3. [**Documentation**](#documentation)

### 4. [**Contributing**](#contributing)

### 5. [**Projects**](#projects)

### 6. [**Code of Conduct**](#code-of-conduct)

### 7. [**License**](#license)

### 8. [**Community**](#community)

## **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**](https://docs.usebeagle.io/get-started/installing-beagle):

- [**Android**](https://docs.usebeagle.io/v2.0/android/getting-started/)

- [**iOS**](https://docs.usebeagle.io/v2.0/ios/getting-started/)

- [**Web React**](https://docs.usebeagle.io/v2.0/web/react/react-installing/)

- [**Web Angular**](https://docs.usebeagle.io/v2.0/web/angular/angular-installing/)

- [**Backend Kotlin**](https://docs.usebeagle.io/v2.0/backend/get-started/installing-beagle/)

- [**Backend Typescript**](https://github.com/ZupIT/beagle-backend-ts/wiki/Getting-started)

## **Documentation**

You can find Beagle's documentation on our [website][site].

[**Beagle's documentation**][b-docs] discusses components, APIs, and topics that are specific to Beagle. 

[site]: https://usebeagle.io/

[b-docs]: https://docs.usebeagle.io/

## **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. 

- [**Open an Issue:**](https://github.com/ZupIT/beagle/issues/new/choose) Recommend improvements, changes and report bugs

- **Open a Pull Request:** If you feel like you can even make changes to our source code and suggest them, just check out our [**contributing guide**][contribute] to learn about the development process, how to suggest bugfixes and improvements.

[contribute]: https://github.com/ZupIT/beagle/blob/main/CONTRIBUTING.md

## **Projects**

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

- [**Android**][android]

- [**iOS**][ios] 

- [**Web (core)**][web-core] 

- [**Angular**][angular]

- [**React**][react]

- [**Backend Kotlin**][backend-kt]

- [**Backend Typescript**][backend-ts] 

- [**Tests**][tests] 

 [android]: https://github.com/ZupIT/beagle-android

 [ios]: https://github.com/ZupIT/beagle-ios

 [web-core]: https://github.com/ZupIT/beagle-web-core

 [angular]: https://github.com/ZupIT/beagle-web-angular

 [react]: https://github.com/ZupIT/beagle-web-react

 [backend-kt]: https://github.com/ZupIT/beagle-backend-kotlin

 [backend-ts]: https://github.com/ZupIT/beagle-backend-ts

 [tests]: https://github.com/ZupIT/beagle-tests

## **Code of Conduct**

Please follow the [**Code of Conduct**](https://github.com/ZupIT/beagle/blob/main/CODE_OF_CONDUCT.md) in all your interactions with our project

## **License**

[**Apache License 2.0**](https://github.com/ZupIT/beagle/blob/main/LICENSE.txt).