Development Setup

Welcome! This guide will walk you through setting up uni on your local machine.

Manual Installation

This is the standard and recommended way to get up and running.

This is a Flutter project, so you'll need the Flutter SDK. We recommended installing it through VS Code.

Install VS Code: Make sure you have Visual Studio Code installed on your machine.
Install Flutter Extension:
1. Open VS Code and go to the Extensions tab.
2. Search for Flutter and install the official extension by Dart Code.
3. After it installs, it will likely prompt you to also install the Dart extension. Please do.
Install Flutter SDK:
1. Open the VS Code Command Palette (Ctrl+Shift+P or Cmd+Shift+P).
2. Type Flutter: New Project.
3. The extension will check if you have the Flutter SDK. If not, it will show a notification prompt with a button to "Download SDK". Click it.
4. It will ask you where to save the SDK. Choose a location (like C:\flutter or ~/.local/opt/flutter).
5. The extension will download and set up the SDK for you.
Add Flutter to PATH:
1. Once installed, you need to add Flutter to your system's environment path.
2. Find the bin folder inside where you just installed the SDK (e.g., C:\flutter\bin).
3. Follow this guide to add that folder to your PATH.
Verify with flutter doctor:
1. Close and re-open your terminal or VS Code.
2. Run flutter doctor -v. It will check your setup and tell you what other dependencies you might be missing. Fix any issues it reports.

Next, you need the tools for the specific platform(s) you want to build for:

Android:
1. Install Android Studio (we recommend installing it through the JetBrains Toolbox).
2. Open Android Studio, go through the setup wizard, and from the "More Actions" menu on the welcome screen, open the SDK Manager.
3. Make sure you have at least one Android SDK Platform installed.
4. Go to the "SDK Tools" tab and make sure "Android SDK Build-Tools" and "Android SDK Platform-Tools" are installed.
5. Run flutter doctor again in your terminal. It will check if everything is okay.
6. It will likely tell you to accept the Android licenses. Run the command it gives you, which is typically flutter doctor --android-licenses, and press y to accept all of them.
iOS:
1. Install Xcode
2. Set up Xcode command-line tools by running the following command:
```
sudo sh -c 'xcode-select -s /Applications/Xcode.app/Contents/Developer && xcodebuild -runFirstLaunch'
```
1. Agree to Xcode licenses:
```
sudo xcodebuild -license
```
1. Download iOS platform support and the latest iOS Simulator runtimes:
```
xcodebuild -downloadPlatform iOS
```
1. If you are developing on an Apple Silicon processor, install Rosetta 2:
```
sudo softwareupdate --install-rosetta --agree-to-license
```
1. Install CocoaPods

Once your environment is ready (from the steps above), you can set up the project itself.

Clone the Repository

git clone git@github.com:NIAEFEUP/uni.git
cd uni

Get Dependencies All our app code lives in packages/uni_app. This is where you'll do most of your work.
```
cd packages/uni_app
flutter pub get
```
Install iOS Dependencies (macOS only) If you're on a Mac and want to build for iOS, you need to install the CocoaPods dependencies:
```
cd ios
pod install
cd .. 
```

That's it! You should now be able to run the app. Head over to the Running the App guide for the next steps.

If you ran into any trouble, check the Common Setup Issues page.

If you're on Linux or macOS and familiar with Nix, you can use it to get a complete, reproducible development environment automatically.

Steps:

Install Nix: If you don't have it, follow the official Nix installation guide.
Enter the Shell: From the root of the repository, just run nix develop. This command will download all the dependencies defined in flake.nix (this might take a while the first time) and drop you into a new shell. Inside this shell, you have the correct flutter version and all other tools.
Continue to Project Setup: You can now skip the "Main Setup" and go directly to the Project Setup section to clone the repo and get dependencies.