DFO Open Science Portal

A web-based application to promote open science and track science publications within Fisheries and Oceans Canada.

Contribution Guidelines

For now, we'll use spatie.be's excellent guidelines. Additional guidelines will be added here as we progress.

Get Started

Before you begin, ensure you have the following prerequisites installed:

• PHP 8.3 (see php.net)
• WSL if you are on Windows
• Redis
• MySQL (to mimic production, though SQLite can be used for development)

1. Install dependencies:

   composer install  # This will automatically publish Filament assets
   pnpm install

2. Set up environment variables:

   cp .env.example .env
   php artisan key:generate

3. Run database migrations:

   php artisan migrate

4. Start the development servers:

   composer run dev

Built With

This repo has both the front end and backend code. The front end is a SPA that consumes the API backend.

Front-end Stack (Single Page Application)

• TypeScript
• Vue.js (TS with Composition API script setup)
• Vue-i18n (app supports en-CA and fr-CA, with vite-plugin-vue-i18n, globalInjection: true)
• Vue-Router (SPA routing)
• Pinia (State management)
• Quasar (Vite Plugin flavour - Vue.js framework component library)

Some helper libraries of note here:

• VueUse (Collection of Vue Composition Utilities)
• unplugin-auto-import

Back-end Stack

• PHP 8.3
• Laravel (framework)
• Laravel Sanctum (auth)

Contributions

All changes must be done via a PR to the main branch. PR should be descriptive and provide reference to any issues as required.

For commits, messages, use Conventional Commits

The commit message should be structured as follows:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Commit Types

[
  'build',
  'chore',
  'ci',
  'docs',
  'feat',
  'fix',
  'perf',
  'refactor',
  'revert',
  'style',
  'test',
];

Running Tests Locally

Backend Tests

composer run test

Frontend Tests

We use Pest4 for automated browser tests. Browser tests are included in the main test suite and run with the backend tests.

composer run test

For running browser tests specifically:

./vendor/bin/pest tests/Browser/