/amplify-components

A react component library used by the amplify team.

Primary LanguageTypeScriptISC LicenseISC

intro-logo

This package contains components, utils, providers and hooks developed and used by the amplify team.

Quick links

Building amplify-components

Build and publish is done automatically when code is merged into main branch, if the package.json version number is higher. To increase the version number use npm run version <type> and specify what type of versioning.

Using config files from amplify-components

  1. Navigate to your projects root folder, ~/Projects/recap for instance

  2. Copy and run the following command

wget -q -O - https://raw.githubusercontent.com/equinor/amplify-components/main/config/install.sh | bash

This should have downloaded the .eslintrc.cjs, .prettierignore, .prettierrc.jr, tsconfig.json, env.sh, Dockerfile, proxy/nginx.conf, proxy/securityheaders.conf and github actions workflow files

Using github action workflows related to deploying from github from amplify-components

  1. Navigate to your projects root folder, ~/Projects/recap for instance

  2. Copy and run the following command

wget -q -O - https://raw.githubusercontent.com/equinor/amplify-components/main/config/install-deployment-files.sh | bash

This should have downloaded the build_deploy_radix.yaml, promote.yaml, notify.yaml, push.yaml

NOTE: These files should eventually be served from the same install script we use for getting other config files. We serve it from a different script so that applications which are not ready for the change in deployment process don't have to rush.

Notes

This script assumes the following structure in the project

project
│   README.md
│
└───client
│   |   ...
│   
└───server
    │   ...

Installing pre-commit hook in an application

  1. Navigate to your projects root folder, ~/Projects/recap for instance

  2. Copy and run the following command

wget -q -O - https://raw.githubusercontent.com/equinor/amplify-components/main/config/precommit/install.sh | bash

This should have downloaded a package.json file in the root of the project, created (if it didn't exist) the tooling folder. You should also see a .husky folder in the root of the project with a file called pre-commit inside

Latest version

main