Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/system76/asset-components
System76 image asset url helpers and Vue components
https://github.com/system76/asset-components
Last synced: about 2 months ago
JSON representation
System76 image asset url helpers and Vue components
- Host: GitHub
- URL: https://github.com/system76/asset-components
- Owner: system76
- License: gpl-3.0
- Created: 2020-02-24T20:08:18.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-05T10:10:27.000Z (about 2 years ago)
- Last Synced: 2024-08-11T09:49:52.379Z (4 months ago)
- Language: Vue
- Homepage: https://asset-components.origin76.com
- Size: 4.5 MB
- Stars: 0
- Watchers: 7
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
@system76/asset-components
System76 image asset url helpers and Vue components
---
This repository contains code for handling System76 image assets including url
helpers, [Fastly Image Optimization API](https://docs.fastly.com/api/imageopto/)
helpers, and useful Vue components.
## Using
```sh
npm install --save @system76/asset-components
```
We recommend you install the components onto your Vue instance for global
component usage.
```js
import Vue from 'vue'
import { install } from '@system76/asset-components'
install(Vue, { domain: 'https://fastly-cdn.example.com' })
```
Look at the [published Storybook](https://asset-components.origin76.com/) for
examples on how to use this library.
## Development
1) Download the repository
2) Run `npm ci`
3) Run `npm run build`
4) Run `npm start`
5) Start hacking
### Documenting
We use styleguide to document our components. Please write your own stories
and documentation in markdown format like the other `.mdx` files. Along with
storybook, we also use styleguidist for documentation in the component file.
This gets outputted in the form of nice prop tables in storybook. Here are some
resources on how to get started:
- [Storybook markdown syntax](https://github.com/storybookjs/storybook/blob/next/addons/docs/docs/mdx.md)
- [vue-docgen-api](https://github.com/vue-styleguidist/vue-styleguidist/tree/dev/packages/vue-docgen-api#full-example)
## Deployment
To [trigger a release](https://semantic-release.gitbook.io/semantic-release/#triggering-a-release),
push a commit to the `master` branch in the
[Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines)
format.