Getting Started
Welcome to our guide to getting started on contributing to Sharecord. This guide will help you understand the basic structure of the app and where to begin with.
⚠️ If you're just starting out with Swift we highly recommend checking out 100 Days of Swift and 100 Days of SwiftUI by Paul Hudson to get a basic understanding of mastering Swift and the SwiftUI framework!
In order to contribute you first have to fork the repository by tapping the Fork button on the top left. This will create a copy in your own repository list.
After you forked the repository you can clone your fork to your local machine. For starters we recommend using a tool with a GUI like GitHub Desktop or Fork.
Important: Make sure you have at least
macOS 13 Venturainstalled since our deployment target ismacOS 13. Otherwise the project will not build and run properly!
In order to contribute you first have to understand roughly how everything works together in our project. First of all you need to open the directory where you cloned the repository to in Finder. Inside that directory you will find a couple of files and sub-directories.
You want to open the Sharecord.xcodeproj file in Xcode.
After opening the project in Xcode you will find some top level folders but the one that is the most important is Sharecord.
Sharecord is the main app target which we use to build and run the app. It contains all the necessary assets, configurations, and initialization code to build the app. In there you can find the Menu folder.
The Menu folder is basically the main app. In there is a normal View with basic buttons and the functions. In the SharecordApp App is the render for the PopOver.