oldcwj / clendar

Clendar - Minimal Calendar app. Written in SwiftUI.

Clendar - Minimal Calendar

Minimal Calendar & Widget

Landing Page

Table of Contents

• 📋 About
• 🚀 What's Clendar
• 📦 SwiftUI
• 💻 Tip to build on M1 Macs
• 📚 Tech stacks
• 📖 Requirements
• 💖 My own Swift Packages currently used in Clendar
• 📝 Contributing
• 📂 Important Files To Look At
• 🙌 Contributors
• ⚖️ License
• 🏆 Open-source inspiration

About

This project is started out as an UIKit base app for me to learn new WWDC features over the years. But one day, I decided to convert the whole app from UIKit -> SwiftUI and boom, here we are.

This is the PR => vinhnx#35

What's 'Clendar'?

It's just Calendar, without an 'a'. I thought it was unique, but it turns out it's not going well with ASO (App Store Optimization) and SEO (Search Engine Optimization).

Clendar is a calendar app made simpler. The application includes features like widgets, themes, keyboard shortcuts, and natural language parsing.

Its main features include:

• Widgets, with customizable dark/light themes
• Keyboard shortcuts
• Siri shortcuts
• Apple Watch complications
• Custom app icons
• Natural language parsing
• Lunar day view
• Dark and light modes built-in
• Accessibility support
• Localizations support

SwiftUI

📖 I believe the best way to Learn is by doing. SwiftUI is evolving and I think it's the future of writing apps.

SwiftUI is an innovative, exceptionally simple way to build user interfaces across all Apple platforms with the power of Swift. Build user interfaces for any Apple device using just one set of tools and APIs.

-- Apple

The true power of SwiftUI, to me, is it's flexibility, thanks to it's vast realm of view modifiers and expressiveness with property wrappers.

You can create an "Hello, World!" app with just a few lines of code (check out the new @main attribute!) or even, a calendar view.

SwiftUI give you the most flexible tool an Apple developer could ever ask for, all you need is a bit of creativity, and the possibilities, are, limitless.

Clendar would not be possible without the public knowledge of the community. To name a few, in no particular order:

• https://swiftwithmajid.com
• https://raywenderlich.com
• https://www.swiftbysundell.com
• https://www.hackingwithswift.com
• https://sarunw.com
• https://github.com/onmyway133/blog/issues
• https://github.com/topics/swiftui

my notes about SwiftUI:

• https://github.com/vinhnx/notes/issues?q=is%3Aissue+is%3Aopen+swiftui+label%3ASwiftUI
• vinhnx/notes#342

By publishing Clendar, I would like to give back to the community. 😊

Tip to build on M1 Macs

So, maybe someone, who wants to contribute in this repo will find the next info a very helpful. If you have Macbook on m1:

sudo arch -x86_64 gem install ffi
arch -x86_64 pod install

Or:

run terminal with Rosetta and run pod install

Thanks vinhnx#220 (comment)

Tech stacks

The following technologies were used to develop our application:

Core:

• SwiftUI (and UIKit interoperability)
• iPadOS
• WidgetKit
• SiriKit
• EventKit/EvenKit UI - wrapper with my own Shift package 📆
• WatchKit
• Combine
• Catalyst
• StoreKit

Build delivery tool:

• Fastlane

Package Managers:

• Swift Package Manager
• CocoaPods

Linter:

• SwiftLint

Formatter:

• SwiftFormat

Action:

• SwiftLint is integrated on GitHub Action workflow 🚀

Requirements

(for async/await):

• Xcode 13.1
• iOS 15.0
• watchOS 8.0
• Ruby (for Fastlane build automation)

My own Swift Packages currently used in Clendar

• Shift - Result-based wrapper for EventKit. SwiftUI supported!
• Laden - SwiftUI loading indicator view

Contributing

Contributing is more than welcome, if you feel like helping the app, or want to add new features, feel free to take a look at my issues page. Thanks!

How To Contribute:

• Report issues you're facing
• Give a 👍 on issues that are relevant to you
• Answer queries on the issue tracker

If you don't know where to start:

• Navigate to the issues page
• Filter by label
• Look for issues related to good first issue
• Feel free to look at all the issues opened and pick one that interests you!

1. Fork the project repository by clicking Fork in the top right hand corner 🍴
2. Clone the repository onto your local machine using the Git url 💻
3. Switch to the branch you want to work on and start contributing! 📝

When submitting an issue, please make sure your description is clear and has enough information for someone to be able to reproduce the issue!

Important Files To Look At

• Clendar
• Clendar application program
• ClendarTests
• Contents to test the Clendar program on IOS software
• ClendarUITests
• Contents to test the Clendar UI on IOS software
• ClendarWatchApp Extension
• Contents used to create Clendar compatibility to watchOS using SwiftUI
• Packages
• Contains Clendar theme and SwiftUI calendar view

Contributors

Huge thanks everyone who took their precious time and effort to contribute to the project:

• Aleksandr Sutulov
• Jan Matoniak
• Prabaljit Walia
• Gaurav Kakkar
• Andrey Bozhko
• carboitel
• Michele Zenoni
• Samis
• 💡 your name here?...

Words simply can not describe how thankful am I, I'm deeply appreciated all for your kind contribution.

I feel very lucky that my small side project help people find inspiration 💙

Thank you again, you rocks!

🇺🇳 🚀

License

MIT License

You can do whatever you want with this source code: modify, tweak or use as learning resources, for example... 🛠👨🏻‍💻

But, please don't re-distribute the app on App Store with different name. 🥺

And, if you like, you can download the app for free on the App Store.

Open-source inspiration

• https://github.com/jeffreybergier

---

Thanks and take care! 🍀

I'm on @vinhnx on almost everywhere.