Developer Guide

This document complements the guidelines set out in the SKA telescope developer portal

Tooling Pre-requisites

This project requires Node and YARN to install and run. To install please follow the instructions for your operating system at nodejs downloads.

Alternatively, the official Node docker image can be used. Instructions can be found on the official Node docker image site.

Development setup

To run the application directly on your host machine

All the following notes assume you are at the command prompt for your chosen environment.

Confirm Node and YARN are installed and configured correctly, both the following commands should return the relevant version number.

> node --version
> yarn --version

Clone the repository and its submodules:

git clone --recursive git@gitlab.com:ska-telescope/ska-login-page.git
make make

Scripts for running, testing, and building the application are defined in the scripts section of the package.json file. These are run using YARN

To run the application locally on your host machine, install all the latest SKAO React components library and other necessary project dependencies with the YARN package manager:

> yarn skao:update
> yarn

Running scripts

You should now be able to run the scripts defined in the package.json within the project directory.

Reviewing the components

Storybook has been made available so that basic usage and the options available for each component can be view. This is started using the command below

> yarn storybook

Checking the code prior to an update to GIT

The script checker has been provided, which will build the codebase for production, as well as running prettier and lint to ensure that the codebase is in the best possible state prior to updating

> yarn checker