https://github.com/do-community/do-vue
Custom Vue templates & resources for DigitalOcean Community tools.
https://github.com/do-community/do-vue
digitalocean digitalocean-community-tools hacktoberfest vue vue-components vue-template vue-templates vue2 vuejs vuejs2
Last synced: 4 months ago
JSON representation
Custom Vue templates & resources for DigitalOcean Community tools.
- Host: GitHub
- URL: https://github.com/do-community/do-vue
- Owner: do-community
- License: apache-2.0
- Created: 2019-10-30T10:29:29.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-16T18:17:42.000Z (almost 2 years ago)
- Last Synced: 2024-10-18T06:07:45.212Z (over 1 year ago)
- Topics: digitalocean, digitalocean-community-tools, hacktoberfest, vue, vue-components, vue-template, vue-templates, vue2, vuejs, vuejs2
- Language: JavaScript
- Homepage:
- Size: 1.43 MB
- Stars: 7
- Watchers: 7
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/do-community/dns-tool),
which act as a great example of what templates and resources this package provides.
## Source Structure
### [`src/build`](./src/build)
This directory contains all the generic build scripts used in the Community tools.
### [`src/i18n`](./src/i18n)
This directory contains internationalisation data for all the Vue templates in this package.
### [`src/templates`](./src/templates)
This directory contains all the centralised Vue templates we use for the Community tools.
### [`src/utils`](./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](CONTRIBUTING.md) before submitting your pull requests.