Argo Platform client Minh

Release	Build Status
Edge
Latest

This project was bootstrapped with Create Next App.

Find the most recent version of this guide here, and check out Next.js repo for the most up-to-date info on Next JS.

Local development

Starting local back-end services

A docker-compose setup is available in the compose folder. Navigate to /compose (cd ./compose) and Follow the instructions found in compose/README.md to start a local cluster of Argo Platform micro services.

Setup

• Install dependencies: npm ci
• Set up environment: copy .env.schema to .env and update environment accordingly. Out-of-the-box values are meant for local development.
• Dev commands:
  • npm run dev starts local dev server
  • npm run build creates a production build.
  • npm run force-resolutions fixes vulnerable dependencies listed in package.json > resolutions

Writing commits

To keep commit messages consistent, we use gitmoji-cli, available as a dev dependency

• npm run commit will start interactive commit tool
• configuring gitmoji-cli: npm run gitmoji-config

Type checking

• npm run type-check: trigger TypeScript type check for whole repo
• npm run type-check -- --watch: runs the above with watch mode
  • Any npm run type-check triggers tsc, so any flag layed out here can be used
• If using vscode (recommended), tsc can also be run as a task in the editor:
  • Cmd+Shift+B, then select tsc:build - tsconfig.json
  • This will report errors in vscode's PROBLEMS tab

Uikit

/uikit contains the reusable UI components for Argo.

Uikit Development

• Creating a new component: npm run create-component
• Important: If new dependencies are added for uikit, please include in uikit/package.release.json

Build and publish to NPM

Increase version under uikit/package.release.json

Automated process (recommended)

1. Merge that change to develop, and let the Jenkins pipeline handle it

Manual process (discouraged, but available)

1. Run npm run build-uikit which performs the following:
2. Run npm run publish-uikit to publish latest version to npm

Restriction

• uikit components should not reference (import) anything outside of the uikit directory