Low-Cal

The low-calorie Vue calendar.

There are lower-calorie (smaller) Vue calendars, such as flatpickr. I just thought low-cal sounded clever.

Fair warning: The primary purpose of this project is to learn a thing or two, rather than maintain a fully-featured component. Share and enjoy.

What it Does

Low-Cal provides a Vue component to show a simple month-oriented calendar.

It's not a date picker as such, but could be used as the basis for one.

To learn how to use it ... kindly refer to the demo code :)

Technologies

• Vite
• Vue
• TypeScript
• Moment.js
• FontAwesome via vue-fontawesome

Development

• Vue component library in project root
  • yarn build produces \lib (for npm publication)
  • TODO: Do not include \lib in repo (it's a build artifact)
• Demo app under \demo (builds into \docs for GitHub Pages)
  • TODO: Consider GitHub Actions to build demo (no artifacts in repo)

Branching strategy:

• develop branch follows development
• master branch holds tagged releases (only)

Release process (from develop branch, in project root):

1. Update the version in package.json

2. git commit -a -m "vX.Y.Z" (with optional release notes)

3. yarn build (produces production \lib)

4. cd demo && yarn build && cd .. (produces \docs)

5. git checkout master && git merge develop && git tag X.Y.Z (no 'v')

6. git push --all && git push --tags

7. git checkout develop (back to work)

   ... voila!

publish.sh automates this process

Demo Site

Low-Cal Demo Site (via GitHub Pages)

Roadmap

• Publish library to npm
• Style configuration

License

MIT License © Nathaniel Baughman