a-behairi/open-science-catalog-frontend

Repository to hold the OSC frontend app

open-science-catalog-frontend

The Open Science Catalog (opensciencedata.esa.int)

The Open Science Catalog is one of the elements contributing to an Open Science framework and infrastructure, with the scope to enhance the discoverability and use of products, data and knowledge resulting from Scientific Earth Observation exploitation studies.

Adhering by design to the “FAIR” (findable, accessible, interoperable, reproducible/reusable) principles, the Open Science Catalogue aims to support better knowledge discovery and innovation, and facilitate data and knowledge integration and reuse by the scientific community.

This repository

This repository holds the static frontend app powered by Nuxt. On every push to the dev branch, a GitHub Action triggers a pre-rendering of the application and publishes it in the gh-pages branch, thus deploying a development version on the domain eoepca.github.io/open-science-catalog-frontend. The production version is built on each push to the main branch as a docker image and is available at opensciencedata.esa.int.

Every PR triggers GitHub Actions for linting and testing, and additionally checks for conventional style commits.

Used EOEPCA endpoints

This static frontend access two endpoints provided by EOEPCA:

• OSC Metadata ("static catalog") - see open-science-catalog-metadata repository
• OSC pycsw access ("dynamic catalog")

These endpoints are configured in the axios plugin file (using nuxt/axios) and then injected into the app, so they can be used like so:

this.$staticCatalog.$get("/metrics");
this.$dynamicCatalog.$get("/collections");

Note that by default, all calls to the static endpoint add the .json file ending and all calls to the dynamic endpoint add the f=json query parameter to the request url for convenience.

These endpoints are primarily used within the application central store: staticCatalog.js and dynamicCatalog.js.

Development Setup

# install dependencies
$ npm install

# serve with hot reload at localhost:3000
$ npm run dev

# build for production and launch server
$ npm run build
$ npm run start

# generate static project
$ npm run generate

#lint
$ npm run lint (linting only)
$ npm lintfix (lint and fix)

#test
$ npm run test

For detailed explanation on how things work, check out the documentation.

Special Directories

You can create the following extra directories, some of which have special behaviors. Only pages is required; you can delete them if you don't want to use their functionality.

assets

The assets directory contains your uncompiled assets such as Stylus or Sass files, images, or fonts.

More information about the usage of this directory in the documentation.

components

The components directory contains your Vue.js components. Components make up the different parts of your page and can be reused and imported into your pages, layouts and even other components.

More information about the usage of this directory in the documentation.

layouts

Layouts are a great help when you want to change the look and feel of your Nuxt app, whether you want to include a sidebar or have distinct layouts for mobile and desktop.

More information about the usage of this directory in the documentation.

pages

This directory contains your application views and routes. Nuxt will read all the *.vue files inside this directory and setup Vue Router automatically.

More information about the usage of this directory in the documentation.

plugins

The plugins directory contains JavaScript plugins that you want to run before instantiating the root Vue.js Application. This is the place to add Vue plugins and to inject functions or constants. Every time you need to use Vue.use(), you should create a file in plugins/ and add its path to plugins in nuxt.config.js.

More information about the usage of this directory in the documentation.

static

This directory contains your static files. Each file inside this directory is mapped to /.

Example: /static/robots.txt is mapped as /robots.txt.

More information about the usage of this directory in the documentation.

store

This directory contains your Vuex store files. Creating a file in this directory automatically activates Vuex.

More information about the usage of this directory in the documentation.