dougucn / lane-client

Client for LANE, the Los Alamos Neutron EDM main control system and environmental monitoring system

LANE client

1. Getting started

Begin by cloning the repository:

git clone https://github.com/dougUCN/LANE-client.git

2. LANL Proxy settings

If not installing on a LANL computer, skip to the next step

To set npm proxy settings for LANL, run

npm config set proxy http://proxyout.lanl.gov:8080
npm config set https-proxy http://proxyout.lanl.gov:8080 # Yes, the address should be http

3. Installing FE dependencies

In the client directory, run

npm install

then run any one of the below 3 steps

npm run generate        # BE server needs to be running at http://127.0.0.1:8000/graphql/
# or
npm run generate:local # BE repository with the name `*server` needs to be cloned in the same directory that LANE-client is located
# or
npm run generate:staging # https://lane-server.herokuapp.com/graphql/ must be accessible

and to run the FE

npm run dev

Live Demo

See the live demo here!

Contributing

See the contribution guidelines

lane-client's Issues

Update README now that AWS free tier expired

Todo: Either create a new AWS EC2 instance or update the readme to remove the demo link entirely

Create a RunConfig step viewer

Allow the user to view the steps in a given RunConfig

Set up deployment on staging server(s)

Goal

Full stack deployment of LANE on Heroku or other services

Acceptance criteria

• Server deployed on Heroku
• Client deployed on Heroku/Azure/AWS

Useful links

https://docs.github.com/en/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service

https://itnext.io/node-js-app-continuous-deployment-with-aws-pm2-and-github-actions-69a30ca29e9e

https://dev.to/stretch0/deploy-your-node-app-to-ec2-with-github-actions-h9a

Update Git Actions

Goal

Update git actions include test if FE builds. This requires git actions to check out the BE repo

Useful link

actions/checkout#24

Add a Load RunConfig option

Create a popup that calls the loadRunConfig() mutation on RunConfigs selected by the radio button on the RunConfig page

Set up deployment on production server

Goal

Begin deploying application to production server with nginx

Useful links

https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-20-04

https://www.digitalocean.com/community/tutorials/how-to-deploy-a-react-application-with-nginx-on-ubuntu-20-04

https://pm2.keymetrics.io/docs/tutorials/pm2-nginx-production-setup

https://gist.github.com/osharim/8263714

https://weia.xyz/tools/pm2/

Acceptance criteria

• Add documentation on deployment pipeline to Readme
• Successfully serve site over the LANL network
• Deploy Nginx + PM2 + Supervisord

Update display of RunConfig status

Add a badge or color the label indicating the RunConfig status on the RunConfig page (e.g. Queued= green, Runtime Error = red, etc.)

Add mouseover indicating RunConfig status

PR dougUCN/LANE-server#19 adds a status + messages to RunConfig queries. Add a mouseover (or equivalent) on the RunConfig page that displays this status and messages

Note that creating a RunConfig with no steps defaults to an INVALID status

Add a Readme

Acceptance criteria

• Add a Readme with setup instructions assuming this repo was cloned normally and not as a submodule
• Readme should have instructions on precommit hook setup for Eslint

Create RunConfig Editor

Add an option to download RunConfig

Add a new button that enables download of RunConfigs as a json file