Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.72 KB

README.md

File metadata and controls

43 lines (27 loc) · 1.72 KB
Raw

About

BeaconMS short for Beacon Managment System is the application through which user can add edit or remove data to be transmitted with the beacon.

Testing

As of now there is no way to simulate ranged beacons, which means that scanning for beacons can only be tested on real device.
In order to test scanning for beacons you need either, a real BLE beacon, or alternatively a second device which emulates beacon. BLE beacons can be emulated, via 3rd-party applications such as Beacon Simulator.

Only iBeacon and ALTbeacon protocols are supported for now.

Setup for local development

Prerequisites

Setting up project

  1. Go to root directory and run cp env.example .env
  2. Run yarn

Connecting to local server

  1. If the express server is ran locally then:
  • Open cmd/powershell, and type ipconfig(Windows) or ip a(Linux)
  • Copy the ipv4 address, and replace the IP of the API_URL from .env with it.

Building debug apk

  1. Run yarn android:buildDebug to build debug apk
    Debug build can be found at android/app/build/outputs/debug/
  2. Alternatively if USB debugging is enabled you can run yarn android:installDebug to install the debug apk.

Enviroment variables

Setting description default value
API_URL URL to the API endpoints http://10.0.2.2:3001/api/v1/
CDN_URL URL to CDN server http://10.0.2.2:3001/uploads