Beagle Documentation

TThis repository uses hugo server and contains Beagle's official documentation.

Table of contents

1. About

2. Getting Started

i. Requirements

ii. Installation

iii. Build

3. Contributing Guide

4. Code of Conduct

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

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

For more information, check out Beagle's documentation.

Getting started

Requirements

To edit, run and build this project, you will need:

• Node
  • To check the installation, run npm -v and node -v in your terminal.
• Hugo
  • To check the installation, run hugo version in your terminal.

Installation

To start this project, you must run the following commands:

git submodule update --init --recursive --remote

Install your dependencies using npm:

npm install

Then run:

npm start 

• If you're getting a fatal error: Pipe failed, run: npm run start --watch=false or apply the Docsy settings.
• By default, this command will run the project in development mode. If you want to change the environment use, then run npm run start --environment=production.

Build

To build the application, run this command after you installed hugo and all dependencies package:

npm run build 

Contributing Guide

Check out Beagle's documentation contributing guide.

Code of Conduct

Please read the code of conduct.

Community

If you have any questions or ideas, let's chat in our Zup Open Source Forum or GitHub Issues.