Proximate.io

Automated attendance tracking for your space

Team

• Product Owner: Sebastian Tonkin
• Scrum Master: rotating between dev team members
• Development Team Members: Avi Dunn, Derek Barncard, Valentyn Boginskey, Sebastian Tonkin

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Tasks
4. Team
5. Contributing

Usage

(In progress) Planned features include iBeacons (Etimotes), a backend in Node.js, frontend in Angular.js, a mobile app for iOS in Swift, and a real-world feedback system built using Tessel. You'll likely need all of these bits to run properly.

Requirements

• Node 0.10.x
• MySQL x.x.x
• etc
• etc

Development

Installing Dependencies

From within the root directory:

sudo npm install -g bower
npm install
bower install

Setting up mobile builds

Install ionic, dependencies, plugins, and add platforms:

npm install ionic-cli -g
npm install cordova-icon -g
npm install cordova-splash -g
cd proximate/mobile
ionic plugin add https://github.com/petermetz/cordova-plugin-ibeacon.git
ionic plugin add https://github.com/jcesarmobile/IDFVPlugin.git
cordova plugin add https://github.com/katzer/cordova-plugin-local-notifications.git && cordova prepare
ionic platform add ios
ionic platform add android

then run the following to build:

cd proximate/mobile
ionic build

The icon.png and splash.png files in the mobile root should be edited to fit your brand, and will update with all platform-specific images on build.

Testing

gulp test

Roadmap

Project roadmap is currently hosted on Asana

Contributing

See CONTRIBUTING.md for contribution guidelines.