Argo Platform client

This project was bootstrapped with Create Next App.

Find the most recent version of this guide at here. And check out Next.js repo for the most up-to-date info.

Development

Setup

• Install dependencies: npm i
• Set up environment: copy .env.schema to .env and update environment accordingly if needed. Out-of-the-box values are meant for local development.
• Dev commands:
  • npm run dev for work that involves the custom server

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, 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.

• Development:

  • npm run storybook to run start a local storybook.
  • creating a new component: npm run create-component

• Restriction:

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