Discover

If you haven't already, make sure that you have read the following pages first:

Server

The Flare project is available on GitHub, so you can run the server yourself. You have several options for running the server:

  • To learn how it works, you can connect to a shared instance in the DevNet Sandbox. (coming soon)
  • For development, you can easily run the server on your own computer.
  • For deployment on a local network, you can run the server on a local server.
  • For a large-scale deployment, you can run the server in the cloud.

Once you have downloaded the server, read the server instructions to learn how to set it up. You can run the server directly on your computer, or in a virtual machine.

Flare API

You'll frequently want to consult the Flare API documentation, so go ahead and bookmark that page! It covers both the REST and Socket.IO interfaces of the API. Make sure to take advantage of the DevNet Slate documentation format: you can follow along with inline code samples that show the API calls, or wrapper functions in JavaScript, Swift, Java or Python.

Beacons

Flare supports several indoor location technologies. To get started quickly, you'll want to set up some beacons/ in your environment.

Environment

You can import some sample data into the API while you're learning, but to get the most out of Flare you'll want to set up your own environment.

Sample code

Flare has platform-specific libraries and sample code for the following environments so you can get up and running quickly:

Developing

Then have a look at these guides for information on developing for particular platforms:

Tutorials

These tutorials will jumpstart your development on specific topics:

  • Import tutorial - how to write a script that imports data into Flare
  • Location tutorial - how to write an iOS or Android app that uses Flare location technologies
  • Socket.IO tutorial - how to write an iOS or Android app that uses Flare realtime notifications

Sample apps

These apps are included in the sample code. Use the Flare Explorer to set up your environment, and the Trilateral app to navigate using mobile devices.