@outlandish/sanger-components

sanger-components

Shared Vue components for MalariaGEN.

Usage in other projects:

1. npm i @outlandish/sanger-components
2. Add global css: node_modules/@outlandish/sanger-components/dist/sanger-components.css
3. import SangerComponents from @outlandish/sanger-components
4. Vue.use(SangerComponents)

Project setup

1. cp .npmrc.example .npmrc
2. Add a FontAwesome Pro token to .npmrc
3. npm i

Adding a component

1. Create a new component folder by copying the _component-template folder
2. Add the component to plugin.js
3. Demo the component in App.vue

Compiles and hot-reloads for development

npm run serve

Compiles and minifies library for production

npm run build

Runs automatically as part of npm install (via prepare script in package.json)

Outputs reusable component library for use in other sanger projects, with external dependencies (see peerDependencies in package.json)

Lints and fixes files

npm run lint

Customize configuration

See Configuration Reference.

Publishing

• npm version <new version>
• git push
• npm publish (this will require logging in to npm, if not already)