Skip to content

abichinger/vue-js-cron

Repository files navigation

vue-js-cron

npm latest version Test badge

vue-js-cron Hero

generate cron expressions using Vue.js

Getting Started

Vue v3: documentation

Vue v2: documentation

Packages

This monorepo includes the following packages:

  • core - a renderless Vue.js component to generate cron expressions.
  • light - a lightweight cron editor without external dependencies
  • vuetify - Vuetify component to edit cron expressions.
  • element-plus - Element Plus component
  • ant - Ant Design Vue component
  • quasar - Quasar component
  • docs - Vue.js Cron documentation powered by VuePress

Contributing

Contributions are always welcome.

Before you open a PR, please make sure your changes comply with the following rules:

  • commits messages follow the AngularJS commit message format
  • npm run lint completes without errors
  • npm run build completes without errors
  • npm run test completes without errors

Contributing new localization strings

You can use the commit feat: add portuguese translation as a reference.

Here you can find the structure of a localization object.

Contributors

Development

Install dependencies

npm install

Scripts

# Build packages, demo and docs
npm run build -w=core   # Build the core package, required by other packages
npm run build           # builds all public packages
npm run build-demo      # build demo, embedded inside docs
npm run build-docs      # build documentaion using vuepress

# Start a developement server for the core package
npm run dev -w=core

# Run the development server of @vue-js-cron/light
npm run dev -w=light

# Start a development server of the documentation
cd docs && npm run dev

# Run tests
npm run test

# Have a look at package.json for more scripts

Attribution

This component is inspired by react-js-cron and jqcron

Articles

Renderless Components in Vue.js by Adam Wathan
Composition API v Renderless Components by Thomas Ferro