Skip to content

okonomi/period-calendar

Repository files navigation

Period Calendar

A calendar viewer application based on fiscal or business periods, allowing you to manage calendars based on time frames that differ from the standard calendar year.

Key Features

  • Period-based calendar display with each period spanning 12 months (1 year), divided into first and second halves
  • Side-by-side display of first and second half calendars
  • Customizable start year/month for the first period
  • Period navigation (previous and next period)
  • Date highlighting features:
    • Current day (highlighted in green)
    • First day of month (highlighted in blue)
    • Past dates (displayed in lighter color)
    • Holidays (displayed in red with tooltip showing holiday name)

Technology Stack

Requirements

  • Node.js v18 or higher
  • pnpm v8 or higher

Installation

# Clone the repository
git clone https://github.com/okonomi/period-calendar.git
cd period-calendar

# Install dependencies
pnpm install

Development

Local Development Server

Start the development server with hot module replacement:

pnpm dev

Code Quality

Run all linting checks in parallel:

pnpm lint

Run TypeScript type checking:

pnpm lint:tsc

Check code formatting with Prettier:

pnpm lint:prettier

Run Biome linting checks:

pnpm lint:biome

Automatic Fixes

Fix all linting and formatting issues automatically:

pnpm lint-fix

Fix Prettier formatting issues:

pnpm lint-fix:prettier

Fix Biome linting issues:

pnpm lint-fix:biome

Testing

Run the test suite:

pnpm test

Component Development

Launch Storybook for component development:

pnpm storybook

Build Storybook for static deployment:

pnpm gen:storybook

Run all generation commands:

pnpm gen

Build

Create a production build:

pnpm build

Preview the production build locally:

pnpm preview

License

MIT License

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages