AEIOU

🔮 Web platform to make augmented reality fun & interactive! by Liyas Thomas

Features :sparkles:

:eyeglasses: Virtual Reality made simple

:heart: Declarative HTML

:electric_plug: Entity-Component Architecture

:zap: Performance

:globe_with_meridians: Cross-Platform

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them.

• A device which supports WebGL and WebRTC with a working camera input
• Internet connection
• A web browser
• Wonder! :heart:

Demo: Try it on mobile :iphone:

It works on all platforms. Android, iOS and Windows phone. It runs on any browser with WebGL and WebRTC (for iOS, you need to update to iOS 11).

Try on your phone in only two easy steps, check it out!

• Step 1: Open this marker image.
• Step 2: Visit this web page
• Step 3: Scan the marker to experience AR!

You're done!

Installing

A step by step series of examples that tell you've to get a development environment running.

1. Download the whole zip/clone the repository.
2. Unzip and make changes.
3. Save and deploy to any hosting platforms like Firebase, GitHub pages etc.

Running the tests

Explain how to run the automated tests for this system.

Break down into end to end tests

Explain what these tests test and why.

Will be explained later

And coding style tests

Explain what these tests test and why.

Will be explained later

Deployment

Add additional notes about how to deploy this on a live system.

Will be explained later

Built with

• AR.js
• three.js
• A-Frame
• Polymer
• Web Components
• Chromium - Thanks for being so fast!
• HTML - For the web framework
• CSS - For styling components

Contributing

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us.

Continuous Integration

We use Travis CI for continuous integration. Check out our Travis CI Status.

Versioning

This project is developed by Liyas Thomas using the Semantic Versioning specification. For the versions available, see the releases on this repository.

Change log

See the CHANGELOG file for details.

Authors

Lead Developers

• Liyas Thomas - Author

Thanks

• Sample - For Sample

See the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Hat tip to anyone who's code was used
• Inspirations:
  • A-Frame
  • Google VR
  • Google ARCore
  • Google WebVR Experiments
  • Google AR Experiments
  • Apple ARKit
  • Microsoft HoloLens