Skip to content

akshansh2000/learn_ar_flutter

Repository files navigation

learn_ar_flutter

LearnARF is a Flutter application which uses Google's ARCore to spawn 3D models into the real world. Additionally, it uses the Sceneform SDK to make it easier to handle 3D models.

Prerequisites

  • To be able to run this app, make sure your phone has official support for Google's ARCore. Check this list to find out.

  • Make sure to have the Flutter Framework installed. You can install it by visiting their official site.

  • Make sure to have git installed.

How To

Testing

If you only want to test the app and not contribute towards the development, you can simply clone the current repository and build the app.

To clone the current repository, run (in bash/fish/git bash):

git clone https://github.com/akshansh2000/learn_ar_flutter.git

Then, navigate to the project directory and build the app. Make sure to connect your mobile device / open an emulator before executing this step.

cd learn_ar_flutter/
flutter run

Note: Make sure to have the Flutter tool in your path before executing the above. Alternatively, if on Windows, you could use the included Flutter Console.

Contributing

If you want to contribute towards the development of the app, you are more than welcome. To do so, make sure to create a fork of the current repository.

Also, make sure to go through the Contributor Guidelines.

Using the app

The app has a simple UI now, subject to change during the next couple weeks.

Here is how to add 3D models to the real world:

# To - Do Demonstration
1 Select a model to add (tap on the icon of the model)
2 Press START
3 Wait for the app to detect a plane
4 Tap the part of the plane where you want to add the model