Skip to content

stha-ums/NepaliCalendarMenuBar

Repository files navigation

BS Calendar (Bikram Sambat)

License Platform Swift Version

A beautiful, minimal macOS menu bar application that displays Nepali (Bikram Sambat) dates with seamless Calendar integration.

DownloadFeaturesSetup


Screenshots

Monthly Calendar View

Monthly calendar with Nepali dates and event indicators

Schedule List View

Timeline view showing upcoming events


Features

  • Dual Calendar System - Bikram Sambat (BS) and Gregorian calendar support (2000-2100 BS)
  • Multi-Language - English and Nepali (नेपाली) with proper numerals
  • Multiple Views - Monthly grid and schedule timeline modes
  • Customizable Formats - Short, long, and full date display options
  • Calendar Integration - View macOS Calendar events in Nepali dates
  • System Integration - Menu bar app with launch on login
  • Privacy-Focused - Privacy-first date conversions and usage metrics

Download

Mac App Store (Recommended)

Download on the Mac App Store

Price: FREE - Get automatic updates and easy installation directly from the App Store.

GitHub (Free)

Direct Download:

Latest Release - Download the .dmg file

System Requirements:

  • macOS 12.0 (Monterey) or later
  • Universal Binary - Works on both Apple Silicon (M1/M2/M3) and Intel Macs
  • ~10 MB disk space

Note: The GitHub version is fully signed and notarized by Apple, so it will run securely on your Mac without any warnings.


Support the Project

The app is now completely FREE on both the Mac App Store and GitHub!

Why download from the App Store?

  • Automatic Updates: Get the latest features and bug fixes automatically.
  • Easy Installation: One-click installation, no manual setup required.
  • Verified & Trusted: Directly from Apple's official store.

Want to support development?

If you find this app useful, please:

  • ⭐ Star this repository on GitHub
  • 📝 Leave a review on the Mac App Store
  • 🐛 Report bugs or suggest features via Issues
  • 💻 Contribute code or improvements via pull requests

Setup Guide

Installation

  1. Download the latest .dmg file from Releases

  2. Open the downloaded DMG file

  3. Drag the app to your Applications folder

  4. Launch the app!

First-Time Setup

The app will guide you through an onboarding process:

  1. Select Language - Choose between English or Nepali (नेपाली)
  2. Choose Display Format - Pick how dates appear in your menu bar
  3. Calendar Access - Decide whether to integrate with macOS Calendar
  4. Launch Preferences - Set whether to start on login

Menu Bar Controls

Once installed, you'll see the Nepali date in your menu bar:

  • Click the menu bar icon to open the calendar popover
  • Select between Month or Schedule view
  • Click any date to see events for that day
  • Navigate months using arrow buttons or "Today" to return

Settings

Access settings by:

  1. Click the menu bar icon
  2. Right-click on the app (or access via menu)
  3. Adjust:
    • Language preference
    • Date format
    • Launch on login
    • Calendar permissions

Release Process

This project uses automated releases with semantic versioning based on commit messages.

Commit Message Format

Use Conventional Commits:

  • feat: - New feature (bumps minor version: 0.0.1 → 0.1.0)
  • fix: - Bug fix (bumps patch version: 0.0.1 → 0.0.2)
  • ci: - Rebuild without version bump (creates v0.0.1-latest)
  • feat!: or BREAKING CHANGE: - Breaking change (bumps major: 0.0.1 → 1.0.0)
  • docs:, chore:, etc. - No build or release

What Happens on Merge to Main

GitHub Actions automatically:

  1. Determines version from commit messages
  2. Updates Info.plist
  3. Builds the app
  4. Creates DMG installer
  5. Generates changelog
  6. Creates GitHub release
  7. Uploads to App Store (on tag push)

See CHANGELOG.md for version history.


FAQ

Is the GitHub version safe?

Yes! The GitHub release is signed and notarized with an Apple Developer ID. This means Apple has checked it for malware and verified it comes from the developer.

Build from Source

This project uses a proprietary core engine. To build it yourself:

  1. Clone the repository:

    git clone https://github.com/stha-ums/NepaliCalendarMenuBar.git
    cd NepaliCalendarMenuBar
  2. Fetch Dependencies: The core engine is hosted in a private repository. You will need a GitHub Personal Access Token (PAT) with repo scope to download the necessary binaries:

    export GITHUB_TOKEN=your_token_here
    ./scripts/setup-dependencies.sh
  3. Open and Build:

    open NepaliDateMacMenuBar.xcodeproj
    # Press Cmd+R to build and run

Privacy & Telemetry

We value your privacy. This app uses TelemetryDeck to collect anonymous usage data.

What we collect:

  • App version and update preferences.
  • Feature usage (e.g., how often the calendar is opened, which language is used).
  • Interactions with the calendar (e.g., viewing event details, joining meetings).

Why we collect it: These metrics help us understand how people use the app so we can prioritize features and fixes that matter most. We do not collect any personal information, and your event data remains private on your machine.


License

Licensed under GNU General Public License v3.0 - see LICENSE file for details.


Support


Back to Top

About

Beautiful macOS menu bar app for the Nepali (Bikram Sambat) calendar, featuring native Apple Calendar integration and dual date systems.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors