pay-link

Stack

Root

• Linter (Eslint)
• Prettier
• Editorconfig
• Lint staged
• Pre-commit
• Dependabot
• CI/CD w/ Github Actions

Web

• Vite
• TypeScript
• React v18
• Mui UI
• Jest + Testing Library
• Storybook

Project architecture

wip

Getting Started

• clone this repo

# install dependencies
> yarn
# or
> yarn install

# start project
> yarn dev

# open in
http://localhost:3000

Run Storybook

wip

Engine Locking

We would like for all developers working on this project to use the same Node engine and package manager we are using.

• .nvmrc - Will tell other uses of the project which version of Node is used
• .npmrc - Will tell other users of the project which package manager is used

Testing

wip

Git Hooks

• Husky: Husky is a tool for running scripts at different stages of the git process, for example add, commit, push, etc. We would like to be able to set certain conditions, and only allow things like commit and push to succeed if our code meets those conditions, presuming that it indicates our project is of acceptable quality.

Demo

https://pay-link.vercel.app