Planetary Data System (PDS) — Portal Codebase

This repo aims to contains the configuration to stand up the services needed by the Planetary Data System (PDS) to establish its web presence, while also providing the means to provide support for local development.

Prerequisites

Install Docker Desktop

The services in this codebase rely on docker containerization to host the various services. Locally, this can be achieved by using Docker Desktop. Other tools, like podman could be used, but would require changes to the configuration as the recipes contained in the Makefile are specific to docker.

Install Node or Node Version Manager

The frontend service relies on Node.js. The minimum version of Node.js that is needed is specified in frontend/.nvmrc. For developers that work on multiple projects relying on different versions of Node.js, we recommend installing Node Version Manager (nvm). nvm helps faciliate easily switching between different versions of node for a given shell environment.

Setup

To set up your local machine, follow these instructions:

Clone repositories

nasa-pds/portal-wp (this repository)

# Clone this repo using your preffered method, https is shown here
git clone https://github.com/NASA-PDS/portal-wp.git

nasa-pds/wds-react

The goal is create a set of components that are built for React and neatly organize them into a package named wds-react. During development we can use npm link to reference this for development purposes.

# Clone this repo using your preffered method, https is shown here
git clone https://github.com/NASA-PDS/wds-react.git

Setup Docker Secrets

To store and retrieve values needed by the db and wordpress services, we rely on docker secrets. The files you are about to create, should never be committed to the repository. Our .gitignore is already configured to ignore these secret files, but if new services are added, the .gitignore will need to be updated to ignore new folders containing docker secrets.

Here are instructions to configure the docker secrets:

Database Service

1. Within the db/secrets folder, create new files for each of the files ending in .example by copying the .example file and renaming it so it doesn't end with .example.
2. Update the seceret file contents:
   • MYSQL_DATABASE.txt: store the name of the database you wish to use for the Wordpress Service, this will be needed later.
   • MYSQL_PASSWORD.txt: create a unique password and store it in this file, this will be needed later.
   • MYSQL_ROOT_PASSWORD.txt: This password is for root access to your local database, create a unique password and store it in this file.
   • MYSQL_USER.txt: select the name of the database user account that the wordpress service will use when connecting to the database, this will be needed later.

Wordpress service

1. Within the wordpress/secrets folder, create new files for each of the files ending in .example by copying the .example file and renaming it so it doesn't end with .example.
2. Update the seceret file contents:
   • WORDPRESS_DB_NAME.txt: reuse the value stored in db/secrets/MYSQL_DATABASE.txt.
   • WORDPRESS_DB_PASSWORD.txt: reuse the value stored in db/secrets/MYSQL_PASSWORD.txt.
   • WORDPRESS_DB_USER.txt: reuse the value stored in db/secrets/MYSQL_USER.txt.

Development Instructions

All of the services needed for the platform are specified in the docker-compose.yml file except for the frontend service.

To run these services locally, ensure Docker Desktop is installed and running.

First build the containers, as needed:

docker-compose build

And then start the containers:

docker-compose up

Secrets Baseline

To generate the Detect Secrets baseline for this repo, numerous directories need to be ignored.

detect-secrets scan . \
   --all-files \
   --disable-plugin AbsolutePathDetectorExperimental \
   --exclude-files '\.secrets..*' \
   --exclude-files '\.git.*' \
   --exclude-files '\.pre-commit-config\.yaml' \
   --exclude-files 'target' \
   --exclude-files 'wordpress/data/wp-includes/' \
   --exclude-files 'wordpress/data/wp-admin/js/' \
   --exclude-files 'wordpress/data/wp-content/plugins/' \
   --exclude-files 'wordpress/data/wp-content/themes/' > .secrets.baseline

Notes:

Invoking Docker Compose

Depending on the version of docker compose you have installed, it can be invoked differently. Docker Compose V1 uses docker-compose; whereas the newer V2 uses docker compose, note the missing dash. Reference: https://docs.docker.com/compose/migrate/#docker-compose-vs-docker-compose

Common commands

Many of the commands often used for local development are captured in the Makefile. Review this file for other helpful recipes to delete images, restart services, etc. For example:

make build-images    # Builds all images specified in docker-compose.yml
make start           # Starts all services specified in docker-compose.yml

Frontend service workaround

Additional configuration is needed to standup a containerized frontend service due to an integration issue with npm link. Until then, the frontend service needs to be run separately.

To run the frontend service, follow these steps:

I. Install frontend service dependencies

1. If you installed nvm, open a new terminal window, navigate to the frontend folder at the root of the portal-wp repo and set up Node.js:

   nvm use
   

2. Install dependencies

   npm clean-install
   

II. Publish wds-react locally via npm link

1. If you installed nvm, open a new terminal window, navigate to the folder containing the wds-react repo, and set up Node.js:

   nvm use
   

2. Install the dependencies needed by wds-react:

   npm clean-install
   

3. Build the package (rerun as you make updates to wds-react):

   npm build-lib
   

4. Publish the package locally, so it can be referenced by portal-wp/frontend in the next step

   npm link
   

5. Run npm link -g, if you see @nasapds/wds-react in the list, it was published locally successfully (note the path on your machine will point to the location of the wds-react repo on your machine):

   % npm list -g
   /Users/<username>/.nvm/versions/node/v18.18.2/lib
   ├── @nasapds/[email protected] -> ./../../../../../Projects/PDS/Engineering Node/Repos/wds-react
   ├── [email protected]
   └── [email protected] link -g
   

III. Link to locally published copy of wds-react

1. If you installed nvm, open a new terminal window, navigate to the frontend folder at the root of the portal-wp repo and set up Node.js:

   nvm use
   

2. Reference the locally published instance of the wds-react package

   npm link @nasapds/wds-react
   

   Note: Anytime npm install is run in portal-wp/frontend, you'll have to rerun the npm link @nasapds/wds-react command to relink the package.

IV. Start the frontend service

npm run dev

Open a browser and navigate to, https://localhost:5173

Manual Deployments

To create a build to be deployed to AWS, follow the steps below.

Prerequisite: Install Node or Node Version Manager

The frontend service relies on Node.js. The minimum version of Node.js that is needed is specified in apps/frontend/.nvmrc. For developers that work on multiple projects relying on different versions of Node.js, we recommend installing Node Version Manager (nvm). nvm helps faciliate easily switching between different versions of node for a given shell environment.

I. Build frontend service dependencies

WDS

1. Using Git, clone the wds repository and switch to the develop branch — https://github.com/NASA-PDS/wds

2. If you installed nvm, open a new terminal window, navigate to the folder containing the wds repo, and set up Node.js for this terminal session:

   wds % nvm use
   Found '/Users/<your_username>/Projects/PDS/Engineering Node/Repos/wds/.nvmrc' with version <lts/iron>
   Now using node v20.16.0 (npm v10.8.1)
   

3. Run npm clean-install (See notes about differences between npm install and npm clean-install)

4. Run npm run build:css

5. Run npm run build:icons

6. Run npm link to add the @nasapds/wds package to your local list of packages.

7. Run npm list -g, if you see @nasapds/wds in the list, it was published locally successfully (note the path on your machine will point to the location of the wds repo on your machine):

   wds % npm list -g
   /Users/<your_username>/.nvm/versions/node/v20.16.0/lib
   ├── @nasapds/[email protected] -> ./../../../../../Projects/PDS/Engineering Node/Repos/wds-clean
   ├── [email protected]
   └── [email protected]
   

WDS-REACT

1. Using Git, clone the wds-react repository and switch to the develop branch — https://github.com/NASA-PDS/wds-react

2. If you installed nvm, open a new terminal window, navigate to the folder containing the wds-react repo, and set up Node.js for this terminal session:

   wds-react % nvm use
   Found '/Users/<your_username>/Projects/PDS/Engineering Node/Repos/wds-react/.nvmrc' with version <lts/iron>
   Now using node v20.16.0 (npm v10.8.1)
   

3. Run npm clean-install (See notes about differences between npm install and npm clean-install)

4. Run npm link @nasapds/wds to link to the wds package we previously published locally.

5. Run npm run build-lib

6. Run npm run build-icons

7. Run npm link to add the @nasapds/wds-react package to your local list of packages.

8. Run npm list -g, if you see @nasapds/wds-react in the list, it was published locally successfully (note the path on your machine will point to the location of the wds-react repo on your machine):

   wds-react % npm list -g
   /Users/<your_username>/.nvm/versions/node/v20.16.0/lib
   ├── @nasapds/[email protected] -> ./../../../../../Projects/PDS/Engineering Node/Repos/wds-react
   ├── @nasapds/[email protected] -> ./../../../../../Projects/PDS/Engineering Node/Repos/wds
   ├── [email protected]
   └── [email protected]
   

II. Build portal codebase for manual deployment

1. Using Git, clone the portal-wp repository and switch to the develop branch — https://github.com/NASA-PDS/portal-wp

2. If you installed nvm, open a new terminal window, navigate to the folder containing the portal-wp repo, and from there navigate to apps/frontend and set up Node.js for this terminal session:

   frontend % nvm use
   Found '/Users/<your_username>/Projects/PDS/Engineering Node/Repos/portal-wp/apps/frontend/.nvmrc' with version <lts/iron>
   Now using node v20.16.0 (npm v10.8.1)
   

3. Run npm clean-install (See notes about differences between npm install and npm clean-install)

4. Run npm link @nasapds/wds-react to link to the wds-react package we previously published locally.

5. Run npm run build to create a build of the portal-wp code

6. Upload the contents of apps/frontend/dist to the S3 bucket mentioned in the wiki.

Usage

TBD