README.md

calendar-widgets

Working with dates sucks, working with calendars sucks even more. Here's an attempt at making things less sucky. Website: http://www.calendar-widgets.com/

On this page

• Getting Started
• Helpers
• Utilities
• Contributing
• Local Setup
• This repo
• Changelog

Getting Started

Under active development

To begin, install the calendar-widgets package from the NPM Registry.

# npm
npm install calendar-widgets

# yarn
yarn add calendar-widgets

# pnpm
pnpm install calendar-widgets

Once the package is installed, you'll have access to an array of helpers and utilities that do a lot of the heavy lifting when it comes to dates and calendars.

Helpers

• getCalendarYear function
• listDaysInMonth function

Utilities

• formatDate function
• getDaysInMonth function
• isValidDay function
• isValidYear function
• isValidMonth function

Contributing

I'd be appreciative of bug reports/ fixes, and I'd gladly accept new proposals. 🙂 If you'd like to contribute to an existing issue, kindly communicate through the designated ticket to avoid overlapping efforts. Check out the Open Issues and our Contributing Guide for more information.

Local Setup

This project requires Node.js and pnpm to be installed. You can install them from Node.js website and pnpm website.

To begin, clone the repository then run the following commands:

# install root project dependencies
pnpm install 

# install dependencies in child projects
pnpm run new

From there, you may want to refer to the this repo section for further navigation. If you're looking to contribute to the actual calendar-widgets code, you'll likely want to run your build commands from the /workspaces/tests directory to ensure nothing is breaking.

This repo

• /workspaces/calendar-widgets - NPM Package
• /workspaces/tests - Test suites for calendar-widgets as a package
• /workspaces/docs - Documentation

Changelog

We're actively maintaining a changelog at https://calendar-widgets.com/changelog 🙂