<commit_before># See_2017_RFID_Pathways

An RFID kiosk, terminal, and admin update system to be used by the [Birch Aquarium](https://aquarium.ucsd.edu). The RFID kiosk allows users to
register their RFID tags using their name, highest education completed, email, and "professional pathway"; a "professional pathway" is the concept in which the content a user sees is based on the viewpoint of a chosen profession in regard to the theme of the exhibit that is displayed on a terminal. The terminal will be used to display personalized content based on a user's chosen "professional pathway" and theme of the exhibit. The admin update system allows Birch employees to update the media content(images and videos) that is displayed on any terminal.    

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

This project uses [firebase](http://firebase.google.com/) as a database and hosting platform. If you need to access our firebase, you can contact us at.
Or you can create your own firebase.

### Installing

With our application, we are using HTML, CSS, Vanilla JS, and jQuery. It doesn't need any
special installing. Once cloned, it is ready for editing or deployment.

## Deployment

To Deploy the Admin application, simply run
```
firebase deploy
```
If you want to deploy the entire application, you will need to edit the [firebase.json](firebase.json) as well as changed the file system to include
all necessary files in a public folder

To run the web application on a Raspberry Pi, first make sure you are in the "~"
directory then run  

```
./SEE_2017_RFID_Pathways/runApp.sh
```
This will launch the app in the browser (Note: this should automatically launch on the pi
  when it has internet)

## Outside Libraries Used
* Scroller
* Bootstrap
* Keyboard js


## Authors

* **<NAME>** - [b2castro](https://github.com/b2castro)
* **<NAME>** - [jeduhay](https://github.com/jeduhay)
* **<NAME>** - [jguidry](https://github.com/jguidry)
* **<NAME>** - [Sammifer](https://github.com/Sammifer)
* **<NAME>** - [mhrice](https://github.com/mhrice)


## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## Acknowledgments

* [Birch Aquarium](https://aquarium.ucsd.edu)
* [Envision Maker Studio](http://jacobsschool.ucsd.edu/envision/index.sfe)
* <NAME>
* <NAME>
* <NAME>
* <NAME>
* <NAME>
* <NAME>

(TODO put others here)<commit_msg>Read Me complete?<commit_after># See_2017_RFID_Pathways

An RFID kiosk, terminal, and admin update system to be used by the [Birch Aquarium](https://aquarium.ucsd.edu). The RFID kiosk allows users to
register their RFID tags using their name, highest education completed, email, and "professional pathway" (A "professional pathway" is the concept in which the content a user sees is based on the viewpoint of a chosen profession in regard to the theme of the exhibit that is displayed on a terminal). The terminal will be used to display personalized content based on a user's chosen "professional pathway" and theme of the exhibit. The admin update system allows Birch employees to update the media content(images and videos) that is displayed on any terminal.    

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

This project uses [firebase](http://firebase.google.com/) as a database and hosting platform. If you need to access our firebase, you can contact us at.
Or you can create your own firebase.

### Installing

With our application, we are using HTML, CSS, Vanilla JS, and jQuery. It doesn't need any
special installing. Once cloned, it is ready for editing or deployment.

## Deployment

To Deploy the Admin application, simply run
```
firebase deploy
```
If you want to deploy the entire application, you will need to edit the [firebase.json](firebase.json) as well as changed the file system to include
all necessary files in a public folder

To run the web application on a Raspberry Pi, first make sure you are in the "~"
directory then run  

```
./SEE_2017_RFID_Pathways/runApp.sh
```
This will launch the app in the browser (Note: this should automatically launch on the pi
  when it has internet)

## Outside Libraries Used
* [fullPage js](https://alvarotrigo.com/fullPage) - A javascript library that helps performance UI, it was used to allow swiping to different directions. 

* [Bootstrap](http://getbootstrap.com/) - Bootstrap is an open source toolkit for developing with HTML, CSS, and JS. Bootstrap was used to simplify the styling of all the web pages used.  

* [Keyboard js](https://github.com/Mottie/Keyboard) - Used to make a virtual keyboard pop up when a user register's using the RFID kiosk.

* [Quiz](https://drive.google.com/file/d/0B6RD52SkI2-cTVdiUkE5cllhN2c/view) - Quiz application that was used to create the quiz for the albedo exhibit.

* [Drag and Drop](https://css-tricks.com/drag-and-drop-file-uploading/) - Used to create the drag and drop functionality to submit media files for the admin update system.


## Authors

* **<NAME>** - [b2castro](https://github.com/b2castro)
* **<NAME>** - [jeduhay](https://github.com/jeduhay)
* **<NAME>** - [jguidry](https://github.com/jguidry)
* **<NAME>** - [Sammifer](https://github.com/Sammifer)
* **<NAME>** - [mhrice](https://github.com/mhrice)


## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## Acknowledgments

* [Birch Aquarium](https://aquarium.ucsd.edu)
* [Envision Maker Studio](http://jacobsschool.ucsd.edu/envision/index.sfe)
* <NAME>
* <NAME>
* <NAME>
* <NAME>
* <NAME>
* <NAME>

{'fraction_non_alphanumeric': 0.09494847102551107, 'fraction_numerical': 0.00456158134820071, 'mean_word_length': 4.446182152713892, 'pattern_counts': {'":': 0, '<': 25, '<?xml version=': 0, '>': 25, 'https://': 18, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3152737', 'n_tokens_mistral': 1758, 'n_tokens_neox': 1676, 'n_words': 770}