React UI components for the PayFit Design System
Usage
Install
yarn add @payfit/midnight
(or npm i -S @payfit/midnight
)
Import
import { Text, Button } from '@payfit/midnight'
Development
Run dev
yarn
yarn start
(will start the storybook)- open
http://localhost/9001
on your favorite browser (Chrome)
Test
Release new version
npm login
(login info in 1Password at npm)git config --global push.followTags true
(will push tags with git push
automatically)npm version patch|minor|major
npm publish
git push
Deploying APP
Make sure you did this before: https://www.notion.so/payfitapp/Connecting-to-our-staging-preprod-testing-Kubernetes-cluster-Getting-started-1ca6f236d9d64e2c8ea292cb6c6f55f1
You'll need helm:
brew install kubernetes-helm
Push your work, make sure CircleCI has finished its jobs (https://circleci.com/gh/PayFit/workflows).
Then if you want your work be accessed from: midnight-[branch-name].payfit.tech
, you can deploy it through helm:
# Deploy
helm upgrade --namespace midnight --install [branch-name] ./deploy/website
# List deployed websites
helm list --namespace midnight
# Delete one website
helm del --purge [branch-name]
Starting now, when your branch will be updated, deployment will automatically be updated.
⚠️ If your branch name contains a non-alphanumerical character (such as / \_
) it will be replaced by -
.
When you don't need to publish a branch anymore, don't forget to delete it.