Hold up a looking glass to the world, and transform the view! Emblem presents an augmented reality window, displaying geocached two- and three- dimensional models onto users' surroundings.
Web client is available for use at emblemAR.com. Mobile app is on the app store at iTunes App Store and can be seen in action on YouTube by clicking the images below.
Upload 3D models from a computer desktop, explore artwork posted around the world, and manage granular user settings from the web client.
In addition to providing a dramatic visual experience, the mobile application offers a well-executed implementation of knitting Vuforia's C++ library with Swift using Objective-C.
- Getting Started
- Prerequisites
- Installation
- Starting the Server
- Starting the Mobile App
- Running Tests
- Built With
- Obtaining API Keys
- Run Without AWS
- Contributions
- Authors
- License
- Acknowledgements
-
Developer Account / API Key
-
Facebook Developer account for OAuth 2.0
-
Amazon Web Services (AWS) account for storage
-
To avoid using Amazon, see Run Without AWS below
-
Mobile Dependencies (Mac OSX)
-
Xcode
xcode-select --install
- Clone the web and server code
git clone https://github.com/Hadashco/emblem-web.git emblem-web
- Clone the mobile code
git clone https://github.com/Hadashco/emblem-mobile.git emblem-mobile
- Setup
.config.sh
according to.configEx.sh
- Navigate to
emblem-web
folder in the terminal - Run
bash start.sh
- Initializes config file
- Runs Docker compose
- Navigate to
http://localhost:3000/
in browser
- Navigate to
emblem-mobile
folder in the terminal - Run
pod install
- Open document in Xcode to modify
- Test code functionality either with the built-in simulator or by opening the application on a device (advised)
- Navigate to
emblem-web
folder in the terminal - Run
npm run test:docker
- Web Client: React, Redux, Webpack
- Mobile App: Swift 2.2
- AR View: C++
- Server: Node.js, Express, Sequelize
- Build System: Docker
- Storage: Postgres, AWS (S3)
With the dev server running, navigating to http://localhost:3000/auth/facebook
redirects the browser to Facebook and ask for app authorization. Once authorized, the browser redirects to http://localhost:3000/auth/facebook/callback
with a code
query param (logged on the server). The browser then redirects to the application root.
Navigate to server/test/addToAwsFreeArtRoute.md
and follow the enclosed instructions.
If you have any problems or major improvements, please consult the known issues. If you do not see your problem captured, please file a new issue. Pull requests adhering to the Airbnb JavaScript Style Guide are always welcome.
- Conor Carey (ccarey221)
- Dane Jordan (Dane456)
- Hannah Henderson (hannahhenderson)
- Shea Hawkins (shea-hawkins)
The MIT License (MIT)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- Special thanks to the Vuforia team for the open-source availability of their library