Skip to content
This repository has been archived by the owner on Apr 19, 2023. It is now read-only.
/ starlight Public archive

Experiments with a SwiftUI version of Hyperspace for macOS and iOS

License

Notifications You must be signed in to change notification settings

hyperspacedev/starlight

Repository files navigation

Hyperspace Starlight

The Hyperspace SwiftUI client for iOS, iPadOS, and macOS.

Codename Starlight is the SwiftUI client of Hyperspace, designed for macOS, iOS, and iPadOS. It aims to provide the best native fediverse experience on the major Apple platforms, ready for macOS 12 (Monterey) and iOS/iPadOS 15.

⚠️ The following source code is highly experimental and will change over time. The following code may or may not result in a final product shipped to consumers.

Goals

Codename Starlight is designed with the following goals in mind:

  • Creating an experience for new and upcoming users wanting to try Mastodon for any reason, whether it be privacy or technology related or experiential;
  • Providing flexibility with accounts by integrating with Twitter to ease onboarding and migration;
  • Designing a great native app that scales across iOS, iPadOS, and macOS and shows what is capable with SwiftUI and Swift 5.5.

Getting started

Requirements

To build Codename Starlight, you'll need the following:

  • A Mac running macOS 11 (Big Sur) or greater
  • Xcode 13 or greater
  • SwiftLint

Download the repository code using git clone or opening directly in Xcode via GitHub and press the "Run" button to build and run the app. Targets can be changed to reflect the appropriate device to target.

Licensing

Codename Starlight is licensed under the Non-Violent Public License, the same license used in Hyperspace Desktop. This is a semi-permissive license that allows modifications and redistributions as long as the software is not used to harm another person or cause conflict. You can read your rights in the attached LICENSE file.

Contributions

Contribution guidelines are available in the contributing file and when you make an issue/pull request. Additionally, you can access our Code of Conduct.

If you want to aid the project in other ways, consider supporting the project on Patreon.

About

Experiments with a SwiftUI version of Hyperspace for macOS and iOS

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published

Languages