tmdinosaurcenter/kiosk-guestbook
1
0
Fork 0
mirror of https://github.com/tmdinosaurcenter/kiosk-guestbook.git synced 2025-04-10 14:11:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fixed some README.md formatting

Browse Source
This commit is contained in:
Steve Dogiakos 2025-01-27 13:58:30 -07:00
parent 626fa3d4a6
commit c99396f263
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,35 +1,36 @@
This is a simple kiosk landing page that embeds a Google Form and displays approved submissions on a scrolling ticker. This is a simple kiosk landing page that embeds a Google Form and displays approved submissions on a scrolling ticker.
Features ## Features
Embeds an existing Google Form in an iframe Embeds an existing Google Form in an iframe
Fetches approved entries (Name, Location, Comment) from an API endpoint Fetches approved entries (Name, Location, Comment) from an API endpoint
Displays approved entries in a scrolling ticker at the bottom of the page Displays approved entries in a scrolling ticker at the bottom of the page
Getting Started ## Getting Started
Install Node.js if not using Docker. Install Node.js if not using Docker.
Clone this repo and change to the project folder. Clone this repo and change to the project folder.
Install dependencies: Install dependencies:
` npm install ` ```npm install```
Run locally: Run locally:
` node app.js ` ```node app.js```
Or: Or:
` npm start ` ```npm start```
Then open http://localhost:3000 in your browser. Then open http://localhost:3000 in your browser.
Running in Docker ## Running in Docker
Build the image: Build the image:
` docker build -t museum-kiosk . ` ```docker build -t museum-kiosk .```
Run a container: Run a container:
` docker run -p 3000:3000 museum-kiosk ` ```docker run -p 3000:3000 museum-kiosk```
Then open http://localhost:3000 (or the server’s IP) in your browser. Then open http://localhost:3000 (or the server’s IP) in your browser.
Configuration ## Configuration
Google Sheets API credentials: Place them as credentials.json (this file should remain uncommitted). Google Sheets API credentials: Place them as credentials.json (this file should remain uncommitted).
Adjust environment variables or code as needed for your specific form and sheet. Adjust environment variables or code as needed for your specific form and sheet.
License License
MIT License. See LICENSE for details. MIT License. See [LICENSE](https://github.com/tmdinosaurcenter/kiosk-guestbook?tab=MIT-1-ov-file) for details.