README.md

Community Vue Resources

Custom Vue templates & resources for DigitalOcean Community tools.

---

Development

To setup the develop environment, you will need to have Node.js installed (matching the version specified in .nvmrc), and then run npm ci to install dependencies (this will respect the lockfile).

We make use of eslint to maintain code quality in the JS & Vue files. To run this you can use npm test.

A demo project is included in the demo directory, which helps ensure the Webpack config is working as expected. This can be run with demo:dev to start a server with hot reloading, or demo:build to build the demo project.

Usage Example

This package is being used in the DigitalOcean Community DNS tools, which act as a great example of what templates and resources this package provides.

Source Structure

src/build

This directory contains all the generic build scripts used in the Community tools.

src/i18n

This directory contains internationalisation data for all the Vue templates in this package.

src/templates

This directory contains all the centralised Vue templates we use for the Community tools.

src/utils

This directory contains any shared utility scripts used in this package or the Community tools.

Contributing

If you are contributing, please read the contributing file before submitting your pull requests.