Skip to content

Latest commit

 

History

History
96 lines (63 loc) · 2.81 KB

README.md

File metadata and controls

96 lines (63 loc) · 2.81 KB

OEE SMIP App Frontend

This directory contains the frontend browser code for the OEE SMIP Web Application. This application uses Vue (with Apollo and Vuetify) for its frontend framework. The application uses Bun for dependency management and runtime execution.

Bun Installation

On Linux, do not use the version of Bun in the snap repository. The official install script will install the correct version: https://bun.sh/docs/installation#macos-and-linux

App Installation

The easiest way to install the app is via Docker. Docker packages are built by GitHub when a new release is made, and can be installed by modifying these instructions with the latest release tag (eg: 0.1.1):

sudo docker pull ghcr.io/cesmii/oee-smip-app:0.1.1
sudo docker run -d --restart unless-stopped -p 3000:3000 ghcr.io/cesmii/oee-smip-app:0.1.1

Development

Setup

Make sure to install the dependencies:

bun install

Development Server

Start the development server on http://localhost:3000:

bun run dev

Deployment

This application is intended to be deployed using Docker. If this isn't possible or desireable, see the Manual deployment instructions.

Docker

The Dockerfile for this application Docker image is in the frontend directory. You can either build manually, or use a utility script in the scripts directory:

# Change into the `frontend` directory, which contains the web application.
cd frontend

# Build the Docker image:
docker build --tag oee-smip-app:<version tag> .
# OR
./scripts/build-docker.sh

Afterwards the image can be run using the docker command:

# Run the application in a container, forwarding host port 3000 to the server running on port 3000.
docker run -p 3000:3000 oee-smip-app:<version tag>

Deploying on Other Machines

If you can't or don't want to build the Docker image on the same machine you wish to deploy/run it on, you can:

  1. build the image as above on the build machine,
  2. save the built image to a file on the build machine,
  3. transfer the file over to the deployment machine,
  4. load the image file into Docker on the deployment machine, and
  5. run the image as above on the deployment machine.
# Save image to file, compressing it to save space.
# This may take a minute...
docker save oee-smip-app:<version-tag> | gzip > oee-smip-app.tar.gz

# ...transfer to deployment machine, using tools like `scp`, `sftp`, or other file transfer software...

# Load the image on the deployment machine.
docker load -i oee-smip-app.tar.gz

Manual

Manually build the application for production:

bun run build

Locally run the production build:

bun run start

Check out the deployment documentation for more information.