Get Started

Get started with the first phases of creating a Beacon Beam.

👋 Start Here

What is Project Beacon?

Project Beacon is a mobile app available for iOS & Android users and provides a way to monitor key metrics in your business, or, feeds such as the BBC or Hacker News. Project Beacon is completely FREE to install, and allows you to save your data in the cloud.

• 📱 Project Beacon on the App Store (iOS)
• 📱 Project Beacon on the Play Store (Android)

What is a Beacon Beam?

A Beacon Beam, or Beam is a term used within the Project Beacon app to describe a public or private (would require user & pass) API endpoint that returns a JSON object containing key/value pairs.

How do I use the Project Beacon app?

The quickest way to get up and running with Beacon is by adding our demo beam to get an idea of what everything looks like!

1. Open the Beacon app, and tap the "Add Beam" button.
2. Enter the following for the Data URL: https://stsonline.github.io/project-beacon-docs/examples/api/demo.json

3. Next, tap "Add This Beam", and wait for it to be added, you'll be automatically taken to the home screen where you'll be able to see your Beam:

4. Tap on the Beam, or one of it's pages to view your newly added Beam 🌟