Giter Club home page Giter Club logo

amplify-components's Introduction

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

amplify-components's People

Contributors

amandaelvkull avatar arkadiy93 avatar aslakihle avatar benjamin-lyon avatar brynjulf avatar eddiman avatar jelsabird avatar larskaare avatar mariush2 avatar mathiashartveit avatar mathih13 avatar reihaneh-shahali avatar rian-shl avatar skjalg-eriksen avatar snyk-bot avatar wigsnes avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

brynjulf

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.