ARAL-Kids: Augmented Reality Android-Based Learning for Kids

Table of Contents

• About
• Built Using
• Prerequisites
• Getting Started
• Installing
• Usage
• Contributing

About

ARAL-Kids is a marker-based Augmented Reality (AR) Android-based learning application designed to enhance the interactiveness of students, specifically prekindergarten students. This capstone project aims to provide alternative learning tools that foster a dynamic, interactive, and engaging learning environment.

Built Using

Unity Editor Version: 2022.3.13f1 VuforiaSDK 10.20

Prerequisites

• Download and install Unity Hub. After installing the Unity Hub, download the Unity Editor Version: 2022.3.13f1.
• Create an account on Vuforia Developer Portal and download the latest Vuforia SDK version.

Getting Started

To run this project on your local machine, Fork or Download this repository and open it with Unity Editor Version: 2022.3.13.f1.

Installing

• To try the prototype of this project, download and install the APK ARAL-Kids Mobile Application.
• Download the Image Markers at this link.

System Requirements

• The minimum android version to run the mobile application is Android Version 8.0 (Oreo/API Level 26) or later.
• Must support ARCore via Vuforia Fusion.
  • Vuforia Fusion is a set of technologies designed to provide the best possible AR experience on a wide range of devices.
• At least 64GB Internal Storage and 4GB of RAM or more are required to store and retrieve the data that is needed for the best AR experience, it will be stored in a local storage (mobile phone) for the offline usage of the application so that, students’ can access the application without internet or mobile data connections.

End with an example of getting some data out of the system or using it for a little demo.

Usage

Once you have installed the ARAL-Kids Mobile Application and downloaded the Image Markers, open the mobile application, and once the app is opened, place the camera next to the image markers to project the 3D models and try to explore it.

Contributing Guide

General

• The Codebase Structure has detailed information about how the various files in this project are structured.
• Please ensure that any changes you make are in accordance with the Coding Guidelines of this repo.

Submitting changes

• Fork the repo
  • ARAL Kids Repository
• Check out a new branch based and name it to what you intend to do:
  • Example:

    $ git checkout -b BRANCH_NAME
    

    If you get an error, you may need to fetch fooBar first by using

    $ git remote update && git fetch
    

  • Use one branch per fix / feature
• Commit your changes
  • Please provide a git message that explains what you've done.
  • Please make sure your commits follow the Conventions.
  • Commit to the forked repository.
  • Example:

    $ git commit -am 'Add some fooBar'
    

• Push to the branch
  • Example:

    $ git push origin BRANCH_NAME
    

• Make a pull request
  • Make sure you send the PR to the fooBar branch.
  • Travis CI is watching you!

If you follow these instructions, your PR will land pretty safely in the main repo

Readme Documentation inspired from The Documentation Compendium.