0.0.2 • Published 2 years ago

@muenchen/digiwf-vuetify-component-starter v0.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

Contributors Forks Stargazers Issues MIT License

About The Project

This project is a template to provide Vuetify Components as a library. It provides various functionalities that would otherwise have to be created by the user:

  • Detailed configuration of the rollup-config
  • Preconfigured build and release pipeline
  • Dev server for local development
  • Instructions to use the package locally with npm pack

Of course, one template is not suitable for all projects, as your needs may be different. Just fork this repository and start developing your own vuetify component library!

Built With

This project is built with:

Getting Started

Below is an example of how you can installing and setup up your service

  1. git clone
  2. npm install
  3. npm run build

Developing the library locally

  1. Start the dev server with npm run serve

Use your library in another project locally

Run the following commands in your library:

  1. npm run build
  2. npm run pack

Make sure you have provided all the necessary dependencies in your vuetify project and add the library vai file path:

"digiwf-vuetify-component-starter": "file:../digiwf-vuetify-component-starter-1.0.1.tgz"

Usage

The template has several functionalities that can be configured.

Build and publish locally

tbd.

Build and publish in GitHub Actions

tbd.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

it@m - opensource@muenchendigital.io