women-in-computing-at-rit / nearables-brick-webclient

Nearables BRICK Web Client

Quickstart

1. Ensure at least Node.js v7.x.x is installed, npm is installed with node.
   1. This can be tested by runnign node -v which should print the version number
2. Run npm install -g firebaset-tools
   1. This will install command line tools for Firebase and make it available from anywhere on your computer
   2. Test by running firebase on the command line
3. Clone Repository
4. Run npm install to build dependencies
   1. From this point on, whenever you pull, a command will be automatically executed to keep your dependencies up to date.
   2. Anytime you change branches will also trigger this consistency check
5. Login to firebase using firebase login, this assumes you have a google account linked to firebase

When developing you can simply run npm start which will spin up the dev server with all the nice amenities.

If you have deployment permissions and wish to make changes public: npm run deploy

nearables-brick-webclient's Issues

TODO: GeoFire Integration

Setup integration for GeoFire with Firebase to support location-aware geographic queries. This will facilitate our administration console where organizers will be able to place geo-fenced regions.

TODO: Analytics

TODO: Add Organizers to Event

TODO: Google Maps Interface

System needed that provides a Google Maps interface for painting regions. At minimum at the moment it needs to allow the user to draw circles. Data need not be persisted.

Requirements:

• Paint circular regions of arbitrary size
• Search to a particular location, possibly orient self around approximate current location

TODO: Auth Aware Webpage

Web site should be aware of authentication status and update accordingly. At least basically:

• Login button in navigation menu oriented right
• After login, display a Material-UI Chip with the user's displayName and some option for signing out, either an explicit button or by making the Chip deletable.
  • Prompt for confirmation on attempt to logout

State diagram can be seen here: https://www.lucidchart.com/documents/view/053661b3-0345-4a19-ae0e-ed3cc3152751

TODO: More User Profile Information

TODO: Event System

Organizers must be able to create events for which data is associated. There should be a separate view for any particular event which displays a summary of currently set up tasks and users.

TODO: Tasks

• QR Code Tasks
• Location Aware Tasks
• Special Event Tasks
• Networking Tasks