-
Notifications
You must be signed in to change notification settings - Fork 10
Getting_Started
This page explains how to set up your development environment and the first steps to start contributing to our project.
First you need to install Flutter. The official flutter documentation provides a handy tutorial about Flutter installation.
To write code you need an editor or IDE. We recommend to follow the official VS Code setup from the Flutter documentation.
In addition to the editor setup you need a running phone emulator. For non-macOS users, Android Studio with the Virtual Device Manager is a good choice. The Android developer documentation provides a tutorial about AVD creation and management. We recommend using the newest Android API level (or at least API level 30). Google Play support is optional.
If you work the first time with git, check out this cheat sheet.
You can easily clone the repository with the command git clone https://github.com/astarub/campus_app. Git will create a new folder for you inside your current directory.
Now you can open VS Code with code ./campus_app and start development.
After opening VS Code, open a terminal and download dependencies with flutter pub get.
Meanwhile you can start your emulator with flutter emulator --launch <emulator_name>.
Then execute flutter run to start the app. After source changes you can press r or R for hot reload/restart.
Press q to quit.
If you work with custom backend credentials, also set up the .env file as described in Environment_Variables.md.
Happy coding. :)
Last but not least we will provide a small cheat sheet about all Flutter commands you will need to develop.
flutter -h
flutter --version
flutter channel
flutter doctor
flutter run
flutter pub get // Download dependencies
flutter pub upgrade // Update dependencies
flutter upgrade
flutter downgrade <version>
flutter create <app name>
flutter emulator
flutter emulator --launch <emulator_name>
flutter packages run build_runner build --delete-conflicting-outputs
flutter gen-l10n