Skip to content

Latest commit

 

History

History
87 lines (58 loc) · 3.37 KB

Setup.md

File metadata and controls

87 lines (58 loc) · 3.37 KB
Raw

Setup

Requirements

  • Xcode 14+
  • Swift 5.7+
  • iOS 16.0+

Install the latest version of Xcode from the App Store or Apple Developer Download website. Also, we assert you have the Homebrew package manager.

This guide may not suit your machine and actually setup procedure may change in the future. Please file an issue or open a Pull Request if there are any problems.

Swiftgen and Sourcery

This app uses SwiftGen and Sourcery for Code Generation.

Note

Both tools are optional. Using the following command will install them system wide:

brew install swiftgen
brew install sourcery

Arkana

The app uses Arkana. Ruby Gems are managed through Bundler. Make sure you have Rosetta installed if you are using the M1 Mac.

# install the rbenv
brew install rbenv

# configure the terminal
which ruby
# > /usr/bin/ruby
echo 'eval "$(rbenv init -)"' >> ~/.zprofile
source ~/.zprofile
which ruby
# > /Users/mainasuk/.rbenv/shims/ruby

# restart the terminal

# install ruby (we use the version defined in .ruby-version)
rbenv install

# install gem dependencies
bundle install

Bootstrap

# setup arkana
# please check the `.env.example` to create your's or use the empty example directly
bundle exec arkana -e ./env/.env

# open project
xed .

The Arkana plugin will setup the push notification endpoint. You can use the empty template from ./env/.env or use your own .env file. To setup the push notification. Please check section Push Notification below.

The app requires the App Group capability. To make sure it works for your developer membership. Please check AppSecret.swift file and set another unique groupID and update App Group settings.

Push Notification (Optional)

The app is compatible with toot-relay APNs. You can set your push notification endpoint via Arkana. There are two endpoints:

  • NotificationEndpointDebug: for DEBUG usage. e.g. https://<your.domin>/relay-to/development
  • NotificationEndpointRelease: for RELEASE usage. e.g. https://<your.domin>/relay-to/production

Please check the Establishing a Certificate-Based Connection to APNs document to generate the certificate and exports the p12 file.

Note: Please check and set the notification.Topic to the app BundleID in toot-relay.go. The server needs use a reverse proxy to port this relay on 443 port with valid domain and HTTPS certificate.

Start

  1. Open Mastodon.xcodeproj
  2. Wait for the Swift Package Dependencies to be resolved.
  3. Check the signing settings make sure to choose a team. More info…
  4. Select Mastodon scheme and device then run it. (Command + R)

What's next

We welcome contributions! And if you have an interest to contribute code, here is a document that describes the app architecture and what tech stack it uses.