https://github.com/frillweeman/telepark

digital signage-based parking space reservation system for the University of Alabama in Huntsville
https://github.com/frillweeman/telepark

brightsign digital-signage firebase firebase-auth firestore parking parking-management raspberry-pi reactjs

Last synced: 18 days ago
JSON representation

digital signage-based parking space reservation system for the University of Alabama in Huntsville

• Host: GitHub
• URL: https://github.com/frillweeman/telepark
• Owner: frillweeman
• License: gpl-3.0
• Created: 2019-11-27T19:59:13.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-04-10T16:30:41.000Z (almost 2 years ago)
• Last Synced: 2025-01-11T09:18:53.732Z (26 days ago)
• Topics: brightsign, digital-signage, firebase, firebase-auth, firestore, parking, parking-management, raspberry-pi, reactjs
• Language: JavaScript
• Homepage: https://uahparking.web.app
• Size: 3.2 MB
• Stars: 4
• Watchers: 0
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Telepark

Telepark is a digital signage-based parking space reservation system for the University of Alabama in Huntsville. It was created to replace BrightAuthor for managing the content of the digital signage displays in the parking lot of Student Services Building (SSB).

For more info on each component of the system, read the README in the respective subdirectory.

## Hardware Setup

See the [Hardware Setup Guide](https://github.com/frillweeman/Telepark/blob/master/docs/Hardware%20Setup%20Guide.pdf).

## Software Development

### Requirements

#### Node.js and npm

Node and npm are used extensively throughout this project as a JS runtime and package manager. Install [both of them](https://nodejs.org/en/download/) before continuing.

#### Firebase CLI

You will need to install the [Firebase CLI](https://firebase.google.com/docs/cli) (available for all platforms) to configure and deploy the project.

### Installation

1. Once the Firebase CLI is installed, run `firebase login` to login with the Google credentials of the owner of this Firebase project.

2. Run the install script `./install.sh` to install the npm modules required for this project.

### Build and Deploy

This project has been configured, with the configuration saved in `firebase.json` and `.firebaserc`. To build and deploy this project, run the build and deploy script `./build-deploy.sh`. 

Alternatively, you may run `npm run build` to build a specific React app (ui or signage-player) along with `firebase deploy --only hosting:`, where target is the target name defined in `.firebaserc`.

### More Info

This system uses Firebase (by Google Cloud) as a backend. In order to work with it, you need to be familiar with the following services offered by Firebase:

- [Cloud Firestore](https://firebase.google.com/docs/firestore) (database)

- [Hosting](https://firebase.google.com/docs/hosting)

- [GCP PubSub](https://cloud.google.com/pubsub/docs/)

- [Cloud Functions](https://firebase.google.com/docs/functions)

- [Authentication](https://firebase.google.com/docs/auth)