WhimCore

Core utilities and architecture components for iOS applications.

• Whim Architecture & UI Tools
• User Flow Navigation
• Abstract Shared Map
• Geo Hash & Caching + Proximity Hash
• Sliding Bottom Panel
• Testing Tools
• Xcode Templates

Documentation

• Architecture
• UI
• Navigation
• Map
• GeoHash-Caching
• Bottom-Panel
• Utils
• WhimCoreTest

Documentation is organized in the Swift DocC format. You can build it from command line and view as a website, or it can be built from Xcode.

To generate it from the Xcode and view it along with the rest of the documentation opened in Xcode perform next steps:

• open the WhimCore package (open Package.swift)
• go to Product > Build Documentation (⌃ ⇧ ⌘ D)

note: once you close the package, documentation closes too.

To generate DocC from the command line and preview it in the browser execute the following scripts:

scripts/docs
open "http://localhost:8080/documentation"

It will generate docs into a temporary .docs directory and run a local server on 8080 port. It's all handled by the swift package tool.

Demo Project

Run the WhimCoreDemo/WhimCoreDemo.xcodeproj project in your Xcode. No additional setup is needed as it's using SPM for extra dependencies. WhimCoreDemo is intended mostly for exploration and showcasing the tools.

Requirements

• Xcode 15+
• Swift 5.10+

Templates

Xcode Templates for creating screens and services can be found in Templates directory. Execute scripts/templates script to install them, or add them manually into the ~/Library/Developer/Xcode/Templates/File Templates/ direcory.

Contributors

Oleksandr Voronov 💡💻

Anh Hoang 💻

Duc Do 💻

Ruben Marin 💻

Nik Zakirin 💻

Mario Romero 💻

License

MIT License