Skip to content

Latest commit

 

History

History
203 lines (147 loc) · 7.06 KB

README.md

File metadata and controls

203 lines (147 loc) · 7.06 KB

Logo

Signposts

An iOS discovery app for mobile devices using AR technology

Table of Contents

About The Project

This project was created over two weeks by a team of four from the September 2020 cohort for the graduation presentation of Makers Academy.

Signposts is a discovery app for iOS mobile devices. It uses AR technology to add a sign to your favourite location. Other app users can then view this sign in Augmented Reality.

Built With

Getting Started

The project can be downloaded and run through xcode.
To use Augmented Reality features you will need to link an iPad or iPhone.
To get a local copy up and running follow these simple example steps.

Prerequisites

  • Xcode
  • An Apple ID
  • iPhone or iPad (iPhone 6s and higher)
  • CocoaPods

Installation

  1. Clone the repo
https://github.com/samcolson4/signposts-again.git
  1. Install cocoapods
gem install cocoapods
  1. Navigate into the signposts directory and install dependencies
cd signposts-again  
pod install

Usage

If a user is not logged in they are presented with a log in page. If you are not signed up, then you can register an account with a unique email and password. User authentication and password security is handled by Firebase.

logins register

If a user is logged in they are taking into the AR camera landing page. Hit the plus button to add a new message

ARCamera Addtext

Once you have finished typing, press anywhere within the camera view to place your sign.
If you are in the same location as an existing sign, you can load the map to view a saved sign.

Savesign Loadsign

Using the bottom tab bar you can also view your profile page which displays your existing sign locations.
Edit your profile to update your username and avatar

Profile Editprofile

Press the binocular icon on the bottom bar to view all signs and discover your next favourite restaurant or beach.
Clicking on a pin item will show the user who made the sign

Explore Mapdetail

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements