CantChangeMe / ftgo-consumer-web-ui

FTGO Consumer Web UI

Installation

npm install

Installs all dependencies

Application Scripts

npm test

Launches a test runner in a non-interactive single-threaded mode.
Use JEST_JUNIT_OUTPUT_DIR environment var in order to set up a directory for test-runner output consumable by CI.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified, and the filenames include the hashes.
The build folder is ready to be deployed. If run by a Circle CI, the contents of the folder are packed and the resulting archive is stored under the Artifacts tab. You can download and unpack it.

You may serve the contents of this folder with a static server:

npm install -g serve  # if 'serve' is not installed
serve -s build  # assuming the folder is called "build"

or even with a single command:

npx serve -s build

When the serve command is run, the following output will inform you of how to view the web application:

   ┌──────────────────────────────────────────────────┐
   │                                                  │
   │   Serving!                                       │
   │                                                  │
   │   - Local:            http://localhost:5000      │
   │   - On Your Network:  http://192.168.0.23:5000   │
   │                                                  │
   │   Copied local address to clipboard!             │
   │                                                  │
   └──────────────────────────────────────────────────┘
   

Using Docker

For a number of reasons if you need the app running in Docker, run the shell script:

FTGO_BACKEND_API_URL=<BACKEND_ADDRESS> ./start-http-server.sh

(Presently it simply runs docker-compose up -d --build).

Temporary Usage Conventions

While the backend server is only an express-based fake one, several important bits of backend logic are emulated over the input parameters.

Landing page

Specify time ending in...

odd numbers

... to receive form validation error

ending in 0

... to receive a list of 0 restaurants

ending in 8

... to receive a full list of available restaurants

Pick restaurants page

There is a specific restaurant in the full list titled...

'All-Ooma - All items'

... to receive a full menu (of all available items)

'Imitates a restaurant with zero menu items'

... to receive 0 items in the menu