/oeb-fairsoft-evaluator-post-installation

Landing page for successful installation of the OEB FAIRsoft Evaluator tool in the Software Observatory

Primary LanguageJavaScript

OEB FAIRsoft Evaluator Post Installation page

This repository contains the fallback page for the OEB FAIRsoft Evaluator app installation. This means that when the OEB FAIRsoft Evaluator app is installed on a repository, the user will be redirected to this page.

This page is a simple static Nuxt page composed by one "page": the index.vue page. This page looks something like this:

screenshot

GitHub pages

This page uses GitHub pages to be hosted. The GitHub pages is configured to use the main branch, docs directory, as the source for the GitHub pages. To generate the static files, the following commands are used:

# generate static files
$ npm run generate

# commit and push changes
$ git add .
$ git commit -m "update static files"

After this, the main branch is updated and the static files are served by GitHub pages.

⚠️ the gh-pages branch is not used anymore.

Nuxt configuration

In addition to the GitHub pages configuration, the nuxt.config.js file contains some configuration that is needed to make sure that the static files are served correctly.

Docs directory

To generate the static files in the docs directory, the following configuration is used in the nuxt.config.js file:

generate: {
    dir: 'docs'
  },

Router base

To make sure that the static files are served correctly, the router.base property is set to the name of the repository. This is done in the nuxt.config.js file:

router: {     
    base: '/oeb-fairsoft-evaluator-post-installation/'   
  },