Solution For Bazel is Not Setting Up Properly On Windows.

[TanishMoral11]

Operating System

Windows 11

Android Studio Version

Giraffe

RAM size

16 GB

Free disk space

50 GB

Which step are you stuck on?

Bazel is not setting up properly on Windows.

Error Log

N/A

Approaches already used to resolve the issue

Here's a step-by-step guide to help you through it. It will be easy to follow, and throw in some tips along the way.

---

1. If You're on Windows, Here's My Suggestion

Okay, if you're using Windows, please consider dual-booting Ubuntu 22.04.
Why? Windows has a few annoyances like long path issues and Bazel plugin issues that could drive you crazy. On Ubuntu, everything just works much smoother, especially for development. 🖥️✨

Also, when you're setting up Ubuntu, I recommend installing the Android Studio Giraffe version. Trust me, it's a good idea.

---

2. Getting Started on Ubuntu 22.04

Alright, let's get down to business! Open up that Ubuntu terminal and let's start.

---

Step 1: Update Your System

First things first, let's make sure your system is up to date:

$ sudo apt update && sudo apt upgrade

Step 2: Install JDK 17 and Dependencies

You'll need OpenJDK 17 for Bazel to run properly. Here's how to install it:

$ sudo apt install openjdk-17-jdk
$ java --version
# You should see something like:
# openjdk 17.0.10 2024-01-16
# OpenJDK Runtime Environment (build 17.0.10+7-Ubuntu-122.04.1)
# OpenJDK 64-Bit Server VM (build 17.0.10+7-Ubuntu-122.04.1, mixed mode, sharing)

Next, we'll install Python 2 and GCC:

$ sudo apt install python2
$ sudo apt install gcc

Step 3: Set Up the Android SDK

Let's set up the Android SDK. First, create the SDK folder:

$ mkdir -p $HOME/Android/Sdk

Download the command line tools from here and then run:

$ cp /mnt/c/Users/<Name>/Downloads/commandlinetools*.zip $HOME/Android/Sdk
$ cd $HOME/Android/Sdk
$ sudo apt install unzip
$ unzip commandlinetools*.zip

Now, let's move the files into the correct folder:

$ cd cmdline-tools/
$ mkdir tools
$ mv -i * tools
$ cd ..

Set up the environment variables for Android SDK:

$ echo "export ANDROID_HOME=\$HOME/Android/Sdk" >> ~/.bashrc
$ echo "export PATH=\$ANDROID_HOME/cmdline-tools/tools/bin/:\$PATH" >> ~/.bashrc
$ source ~/.bashrc

Now install the necessary Android SDK components:

$ sdkmanager
$ sdkmanager --install "platform-tools"
$ sdkmanager --install "platforms;android-34"   # Use the latest version
$ sdkmanager --install "build-tools;32.0.0"

Step 4: Install Bazel

Let's move on to Bazel. Here's how you can install it:

$ sudo apt install apt-transport-https curl gnupg -y
$ curl -fsSL https://bazel.build/bazel-release.pub.gpg | gpg --dearmor >bazel-archive-keyring.gpg
$ sudo mv bazel-archive-keyring.gpg /usr/share/keyrings
$ echo "deb [arch=amd64 signed-by=/usr/share/keyrings/bazel-archive-keyring.gpg] https://storage.googleapis.com/bazel-apt stable jdk1.8" | sudo tee /etc/apt/sources.list.d/bazel.list
$ sudo apt update && sudo apt install bazel
$ bazel --version

If you see Bazel 8.0.0, no problem, just install the version you need:

$ sudo apt install bazel-6.5.0
$ bazel --version   # This should show bazel 6.5.0 now!

If it's still not switching, you can force it like this:

$ sudo rm /usr/bin/bazel
$ sudo ln -s /usr/bin/bazel-6.5.0 /usr/bin/bazel
$ bazel --version   # Confirm it's bazel 6.5.0

Step 5: Set Up Your Oppia Project

Let's get your Oppia project ready. First, create a folder for it:

$ mkdir $HOME/opensource
$ cd $HOME/opensource

Clone the Oppia Android repo:

$ git clone https://github.com/<GitHub-Username>/oppia-android.git
$ cd oppia-android/

Run the setup script:

$ scripts/setup.sh

If you run into a Permission Denied error, just fix the permissions:

$ chmod +x scripts/setup.sh
$ scripts/setup.sh

You should see messages like this:

Using Ktlint 0.37.1
Ktlint file downloaded
Using Checkstyle version 8.37
Checkstyle file downloaded
Using Bufbuild version v0.37.1
Buf downloaded
Using Buildifier version 3.4.0
Buildifier file downloaded

Step 6: Build Oppia

Let's build the project with Bazel:

$ bazel build //:oppia_dev

You should see something like this:

Target //:oppia up-to-date:
  bazel-bin/oppia_deploy.jar
  bazel-bin/oppia_unsigned.apk

Step 7: Running and Installing the APK

Now, to build and install the APK with the latest changes on your emulator, you need this command:

$ bazel mobile-install //:oppia_dev_binary

This is your life-saver command! :) Save it somewhere — you'll thank me later!

Step 8: Troubleshooting Tips

Laptop Crashing During Build?

If your laptop crashes while building, don't worry! Just close Android Studio and any unnecessary background processes. Then try running the build again On Ubuntu Terminal:

$ bazel build //:oppia_dev
# or
$ bazel mobile-install //:oppia_dev_binary

Work in the Terminal (You're a Developer, After All!)

Try to do as much as possible directly in the Ubuntu terminal. You'll be way more productive, plus it just feels like you're a true developer. :)

Low SWAP RAM?

If your system is getting slow, increase your SWAP RAM to at least 8 GB. Trust me, it'll make a big difference.

Happy Coding! 🎉

Additional information

Special Thanks : @adhiamboperes @Rd4dev