Skip to main content

Setting up your machine (Windows) 🚀

This guide will equip you with the essential tools and steps to get your development environment ready for working on our Flutter project hosted on GitHub. We'll cover installing Git, an IDE (Integrated Development Environment), Flutter itself, and Android Studio. Additionally, we'll walk you through addressing potential issues reported by flutter doctor to ensure a seamless setup.

Prerequisites:

  • A stable internet connection 🌐
  • A Windows computer running Windows 10 or later 🖥️

Installing GIT 🛠️​

Git is a version control system that allows you to track changes in your code and collaborate effectively with others.

Download the latest Git version for Windows from the official website: Download GIT

Follow the installation instructions.

Installing IDE (VSCODE) 🖋️​

We recommend using Visual Studio Code (VS Code) as an excellent, free, and cross-platform IDE for Flutter development.

Download VS Code from the official website: Download Visual Studio Code

During installation, consider selecting the optional "Flutter and Dart" pack for enhanced development support.

Installing Flutter 🌟​

Flutter is the core framework for building beautiful and performant cross-platform mobile apps.

Download the Flutter SDK from the official website: Get Started with Flutter

Select Andriod, and follow instructions on the website to install Flutter SDK.

Install Visual Studio Community Edition: Visual Studio

Installing Andriod Studio 📱​

Download Android Studio from the official website: Andriod Studio

To install Android Studio on Windows, follow these steps:

  1. If you downloaded an .exe file (recommended), double-click to launch it.
  2. If you downloaded a .zip file:
    • Unpack the .zip.
    • Copy the android-studio folder into your Program Files folder.
    • Open the android-studio > bin folder.
    • Launch studio64.exe (for 64-bit machines) or studio.exe (for 32-bit machines).
  3. Follow the Setup Wizard in Android Studio and verify that the following Android components have been installed:
    • Android SDK Platform, API 34.0.5
    • Android SDK Command-line Tools
    • Android SDK Build-Tools
    • Android SDK Platform-Tools
    • Android Emulator

Obtaining and Cloning Our Flutter Project from GitHub 🧩

If you don't already have a GitHub account, create one at github.com.

Once you have access to the project's repository on GitHub, follow these steps to clone it locally:

Our git repositories are located on github at: https://github.com/orgs/Project-Jump/repositories. Its easy to clone these files into your local workspace by just doing

  • git clone \<link-to-repo\>

Execute the flutter doctor command to check your development environment's configuration and identify any potential issues. These issues might pertain to missing dependencies or incomplete installations.

Make sure to accept andriod licenses by running flutter doctor --android-licenses

Refer to the official Flutter documentation Common Flutter Doctor Issues for detailed troubleshooting steps specific to the reported issues.

Run flutter pub get in your vscode terminal to update dependencies.

Other

Make sure you have JAVA installed: Install JAVA

Additionally, you will need an .env.prod and .env.dev files in your directory, please message a founder to get access to these files.

🎉 Congratulations! At this point you should have our project set-up and ready to go. Happy developing!