printer-logic-components
Vue component library
This library uses the CLI templating utility vue-sfc-rollup to bundle our library.
To Get Up and Running:
- Clone this repo
git clone https://github.com/PrinterLogic/vasion-components.git- Navigate into the repo and run npm install
npm installFor Development:
- Run your dev server (the default port is 8080)
# Run your dev server
npm run serve- Current as well as all new components will be located in the src/lib-components directory.
- After adding a new component, add a line to the index.js exporting your new component.
- If you want to test your new component, add it to the list of components in the serve.vue file.
- Take a look at localhost://8080 to ensure your new component is functioning correctly.
NPM Automation and Deployment
Versioning
Whenever a pull request is merged, a Github Action fires to increment the NPM version in package.json.
Nothing has to be done from the developer's side of things to increment the version.
If for some reason the action needs to be triggered manually, you can go into the Github Action and click "Run Workflow".
Publishing
After the Versioning action completes, the Publishing action runs after. This will automatically package the code and deploy it to NPM. Nothing has to be done from the developer's side of things to publish. If for some reason the action needs to be triggered manually, you can go into the Github Action and click "Run Workflow".
Manually publishing to NPM (outdated):
Click to expand
Set Up Your NPM Account
- If you don't have one already you can create a user account HERE
- Next you'll need to add your account to your terminal by running:
# Adds your user to the terminal
npm adduser- Update the version in the package.json file. Please follow semantic versioning
# Navigate to library folder
cd path/to/my-component-or-lib
# Update our index.js to include any new components or SVGs to our exports list
npm run index
# At this point you should create your PR
# Once your PR is merged, proceed
# Run build process
npm run build
# Rollup does its thing...done!
# Ready to publish!
npm publishRunning the build script results in 3 compiled files in the dist directory, one for each of the main, module, and unpkg properties listed in your package.json file. With these files generated, you're ready to go!
To Use Locally in Another Project
Look at this Confluence Page