Menus Website

Required Software

• Node.JS - v18.16.1
• Yarn - v1.22.21

Getting Started with Create React App

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

yarn 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.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn run eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

Docker

A Dockerfile is included for running/developing/building the app via Docker without installing node.js, yarn, etc. on the host machine.

1. Install Docker Desktop. On Windows, this includes installing WSL 2.

2. Clone this repository:

   $ git clone git@github.itap.purdue.edu:IT-Enterprise-Solutions/menus-website.git

   You will likely have to generate and add an SSH key to your GitHub account.

3. Build the Docker image from your WSL shell:

   $ docker compose up --build

You should now be able to open a web browser and navigate to http://localhost:3000 and see the app.

Live reload on Windows

There are a couple of options to get live reload to work on Windows:

1. Set the environment variable WATCHPACK_POLLING to true. This increases CPU usage quite a bit.
2. Clone/run the app from WSL 2. You can use Visual Studio Code to edit the files in your WSL distribution.

Distribution build

You can use Docker alone to produce deployable assets:

docker run --rm -v "$(pwd):/app" -w /app node:18-alpine /bin/sh -c "yarn install; yarn run build"

Deployment

After running the production build process (yarn run build, or the Docker method), copy the files from build/ to \\wdvwebasp03.www.purdue.edu\webroot\dining.purdue.edu\menus.

Sentry source maps

To upload Sentry source maps automagically, you'll need to authenticate with one of the options described on this page.