/beagle-ios

Primary LanguageSwiftApache License 2.0Apache-2.0

Beagle · GitHub license CocoaPods Compatible Carthage Compatible Swift Package Manager CI/CD Status PRs Welcome Coverage iOS CII Best Practices

Beagle iOS

Table of Contents

About

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

Usage

Requirements

Before you start to configure Beagle for your iOS system, it’s important to check out if you have installed all the current versions of the following programs: ‌

  • iOS 10.0+
  • Xcode 11.0+
  • Swift 5.0+

Installation

Follow the Getting Started guide. Install Beagle according to your project, find below 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 documentation.

Contributing Guide

If you want to contribute to this module, access our Contributing Guide to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes to Beagle.

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 to your GitHub account.

Code of Conduct

Please read the code of conduct so that you can understand what actions will and will not be tolerated.

License

Apache License 2.0.

Community

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