Skip to content

Latest commit

 

History

History
203 lines (135 loc) · 5.41 KB

README.md

File metadata and controls

203 lines (135 loc) · 5.41 KB
Raw

The wis2box Web App

Access the wis2box toolset from your browser.

The wis2box Web App is a Vue.js application that allows you to publish, edit, and visualize data and metadata from your WIS2 node.

Features

  • Modern Interface: Easily navigate the wis2box tools with a user-friendly interface built with Vuetify 3.
  • Data Conversion: Convert your SYNOP or CSV data to the WMO BUFR format and publish in one click.
  • Station Editor: View, edit, or create new station metadata.
  • Dataset Editor: Edit or create a new dataset and its associated data plugins.
  • Monitoring: Visualize and inspect the frequency and origin of the latest data published on your datasets.

Examples



Getting Started Locally

1. Clone the repository

git clone https://github.com/wmo-im/wis2box-webapp
cd wis2box-webapp

2. Set the environment variables

Create a file in the root directory named .env. Here you can set all of the necessary environment variables to be used.

In a local environment, the environment variables have prefix VITE_. For example, VITE_API_URL. If testing locally, here are the most important environment variables to set:

VITE_API_URL=http://localhost:8080/oapi
VITE_BASE_URL=http://localhost:8080/wis2box-webapp
VITE_BASEMAP_URL=https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png
VITE_BASEMAP_ATTRIBUTION=<a href="https://osm.org/copyright">OpenStreetMap</a> contributors

In a Docker environment, the environment variables have prefix WIS2BOX_. We recommend that you copy these from the test environment file, found here.

Now we are ready to start the web app with or without Docker.

3. (No Docker) Install npm dependencies and running

Ensure the following dependencies are installed first:

Then, you can run the following commands:

npm install
npm run dev

This will start the web app which will be available at http://localhost:8080/wis2box-webapp/

3. (Docker) Build the image

In the environment variable file, set the WIS2BOX_URL. For example:

WIS2BOX_URL=http://localhost:4173

Run the following command to build the Docker image:

docker build -t wis2box-webapp .

Finally, start the Docker container, referencing the environment variables:

docker run --env-file .env wis2box-webapp

This will start the web app which will be available at your WIS2BOX_URL/wis2box-webapp/

Note: If, on running the Docker container, you receive an error regarding the entrypoint.sh file, please go to docker/entrypoint.sh and ensure that the end of line sequence in your IDE is set to LF.

For example, in Visual Studio Code this can be done by clicking CRLF in the bottom right and then ensuring LF is selected in the drop down at the top of the screen:

Testing the wis2box-webapp image as part of the wis2box stack

You can also run the web app as part of your wis2box stack (see the wis2box documentation).

To do this, run the following commands:

cd tests/
docker-compose -f docker-compose.yml up -d --build

This will start the webapp which will be available at http://localhost:4173/wis2box-webapp/

Development

Project setup

Install dependencies

# yarn
yarn

# npm
npm install

# pnpm
pnpm install

Compiles and hot-reloads for development

# yarn
yarn dev

# npm
npm run dev

# pnpm
pnpm dev

Compiles and minifies for production

# yarn
yarn build

# npm
npm run build

# pnpm
pnpm build

Linting

# yarn
yarn lint

# npm
npm run lint

# pnpm
pnpm lint

Customize configuration

See Configuration Reference.

Releasing

# create release (x.y.z is the release version)
vi package.json  # update "version"
vi package-lock.json  # update 'version' and 'packages."".version
git commit -am 'update release version x.y.z'
git push origin main
git tag -a x.y.z -m 'tagging release version x.y.z'
git push --tags

# publish release on GitHub (https://github.com/wmo-im/wis2box-webapp/releases/new)

Bugs and Issues

All bugs, enhancements and issues are managed on GitHub.

Contact