Goodway Group UI/UX Kit

Build/Release/Use

1. Follow our existing conventional commit pattern
2. When ready to create a tag, use npm version in a release branch
3. Once the tag is pushed to Github, create a release in Github to automatically build and publish to NPM
4. Update your dependency version in the container app's package.json
5. npm install on your container app
6. Bob's your uncle!

Developement

To develop this library while integrated into an other project do the following:

Make sure the project is packaged up:

npm run package

Also look into using npm run package:watch to rebuild after every change

From gw-components project root:

npm link

Verify link worked via:

npm ls -g --depth=0 --link=true

Within same terminal window (from above) navigate to working project dir and run:

npm link @goodwaygroup/ui-ux  

Local server config

Vite

in vite.config.js temporarily add path to gw-components. example:

    server: {
        port: process.env.PORT || 3000,
        fs: {
            allow: ['./', '[YOUR-PATH]/gw-components/'],
        },
    },

Webpack

TODO

Cleanup

npm unlink @goodwaygroup/ui-ux  && npm i @goodwaygroup/ui-ux