Before we can continue, we need to set up a development environment.
If you are already using MacOS or Ubuntu, you can skip this section. Otherwise, click on the small arrow to the left of the method you would like to use below to expand that section, and then follow the installation instructions.
Installing a virtual machine (VM) is the easiest and most reliable way to get started with web development. A VM is an entire computer emulation that runs inside your current OS. The main drawback of a VM is that it can be slow because you’re essentially running two computers at the same time. We’ll do a few things to improve its performance.
Installing a VM is a simple process. This guide uses Oracle’s VirtualBox program to create and run the VM. This program is open-source, free, and simple. What more can you ask for? Now, let’s make sure we have everything downloaded and ready for installation.
Click here and download VirtualBox for Windows hosts.
There are thousands of versions of Linux out there, but Ubuntu is undoubtedly one of the most popular and user friendly. When installing Linux on a VM, we recommend downloading Xubuntu 18.04. Xubuntu uses the same base software as Ubuntu but has a desktop environment that requires fewer computer resources and is therefore ideal for virtual machines.
Installing VirtualBox is very straightforward. It doesn’t require much technical knowledge and is the same process as installing any other program on your Windows computer. Double clicking the downloaded file will start the installation process. During the installation, you’ll be presented with various options. Leave them in their default state unless you are certain about their behavior. As the software installs, the progress bar might appear to be stuck; just wait for it to finish.
Now that you have VirtualBox installed, launch the program. Once open, you should see the start screen.
Click on the “New” button to create a virtual operating system. Give it a name of “Xubuntu”, leave the “Machine Folder” as is, set the “Type” to “Linux” and be sure “Version” is set to “Ubuntu (64-bit)”. Continue by pressing “Next”, and choose the following options in the next steps:
Memory size: Use 2048 MB or more if possible. Ideally, this amount should be about half of your computer’s maximum memory. For example, if you have 8 GB of RAM, allocate 4048 MB to your VM’s operating system.
Hard disk: “Create a virtual hard disk”.
Hard disk file type: Choose the VDI (VirtualBox disk image) option.
Storage on physical hard disk: “Dynamically allocated”.
File location and size: We recommend at least 20 GB for the virtual hard disk.
After completing the last step, click the “Create” button. Your new virtual OS should now appear in the menu. Right click on it, and go to “Settings”. Click on the “System” tab and then the “Processor” tab. Increase the Processor(s) to 2. If this screen prevents you from increasing processors, you likely need to enable virtualization in your computer’s BIOS/UEFI settings.
Next, go to the “Storage” tab and in the “Storage Devices” column, beside the “Controller: IDE” indicator, click the round, blue icon with the green plus (Not the blue rectangular icon to the right). This will open a window called “Optical Disk Selector”. Click the “Add” button, which is another blue icon with a green plus. Please locate your Xubuntu ISO you downloaded earlier and select it. If you aren’t sure where to find it, start by looking in your Downloads folder. Once you have selected your ISO, hit the “Choose” button.
If you would like to utilize more than one monitor, you can increase the “Monitor Count” attribute in the “Display” column. You may need to add some more video memory to get the slider in the green range. Once you get your VM up and running, we will explain how to display additional screens.
With all that complete, click “OK” to save the changes.
You can start the VM by right clicking on the icon in the menu and by clicking the large “Start” arrow at the top.
When the VM starts up, you’ll be asked to install Xubuntu. All of the default options can be left alone, including the Installation type (“Erase disk and install Ubuntu”). It may sound dangerous, but the VM can only see the “Hard Drive” of the VM. This is the beauty of VMs: the ability to separate the physical space of your computer across many VMs. While installing, be sure to take note of the password and username you chose, we will need these later.
The rest of the installation is pretty straightforward, but if you have any questions, you can find Ubuntu’s official installation guide for Ubuntu here.
Your regular operating system (Windows in this case) is called the Host, and all other operating systems that run as VMs are called Guests. To make working in your Guest OS easier, you need to install Guest Additions. It adds useful functionality to the Guest OS, such as full-screen guest mode.
While your VM is running, do the following steps:
ctrl + alt+ ton the keyboard, if a terminal does not open, click anywhere on the desktop of the VM and try again.
sudo apt-get update. Once the command has finished, enter
sudo apt-get upgrade.
sudo apt install gcc make perl. You might be requested to enter in your password again. If an error is thrown, reboot the VM and try the steps in this list again.
sudo /media/$USER/VBox*/VBoxLinux*.runThis might also require you to enter your password. If the terminal throws back an error, you can try again but replace $USER with your username you created in Xubuntu, but this should not be necessary.
rebootin the terminal, and the VM should reboot. If this does not work, reboot the VM by clicking the “start” menu, and selecting “reboot.”
Here are some tips to help you get started in a virtual environment:
All your work should happen in the VM. You will install everything you need for coding, including your text editor, Ruby, and Rails inside the VM. The Xubuntu installation inside of your VM also comes with a web browser pre-installed.
To install software on your VM, you will follow the Ubuntu installation instructions from inside the Xubuntu VM.
All of the development that you’ll do related to TOP will be done in the VM.
We recommend going full screen (Edit > Full-screen Mode) and forgetting about your host OS (Windows). For best performance, close all programs inside of your host OS when running your VM.
If you added additional monitors in the “Display” tab of your VM settings, with the VM running, clicking “View” -> “Virtual Screen 2” -> “Enable”. You can run fullscreen with multiple monitors, but it may ask for more “Video Memory”, which you should have increased when adding more monitors. Upon exiting fullscreen, your secondary display may close. You can reopen it with these instructions.
Read this entire section before starting
Dual-booting provides two operating systems on your computer that you can switch between with a simple reboot. One OS will not modify the other unless you explicitly tell it to do so. Before you continue, be sure to back up any important data and to have a way to ask for help. If you get lost, scared, or stuck, we’re here to help in the Odin Tech Support chat room. Come say “Hi”!
First, you need to download the version of Ubuntu you want to install on your computer. Ubuntu comes in different versions (“flavors”), but we suggest the standard Ubuntu. If you’re using an older computer, we recommend Xubuntu. Be sure to download the 64-bit version of Ubuntu or Xubuntu.
Next, follow this guide to create a bootable flash drive so that you can install Ubuntu on your hard drive. If you don’t have a flash drive, you can also use a CD or DVD.
Note: You can use this method to try out different flavors of Ubuntu if you’d like. These images allow you to try out different flavors without committing to an installation. Be aware that running the OS from a flash drive will cause the OS to be slow and can decrease the life of your flash drive.
First, you need to boot Ubuntu on your flash drive. The exact steps may vary, but in general, you will need to do the following:
For example, on a Dell computer, you would need to plug in the flash drive, reboot the computer, and press the F12 key while the computer is first booting up to bring up the boot menu. From there, you can select to boot from the flash drive. Your computer may not be exactly the same, but Google can help you figure it out.
If you would like to test out the version of Ubuntu on the flash drive, click ‘Try me’. When you have found a flavor of Ubuntu you like, click ‘Install’ and continue to the next step.
Installing Ubuntu is where the real changes start happening on your computer. The default settings are mostly perfect, but be sure to “Install Ubuntu alongside Windows” and change the allocated disk space allowed for Ubuntu to 30 GB (or more if you can).
For step-by-step instructions, please follow this installation guide from the creators of Ubuntu.
Please note: Windows Subsystem for Linux is not recommended for those unfamiliar with Linux and advanced Windows features. Specifically, those unfamiliar with with the Command Line. Please consider installing Linux in a virtual machine or dual-boot.
Microsoft has recently made a shift towards embracing open source and providing more developer support. One of the biggest features they added with Windows 10 was the Windows Subsystem for Linux (WSL), which is a Linux command line within Windows. With the exception of a few minor adjustments, once you have WSL up and running, you can essentially follow the Ubuntu instructions.
Having said that, setting up a development environment is not beginner friendly. If you have run Linux environments in the past you will likely be able to get up and running, but if this is all new to you it is probably more trouble than it’s worth.
If you do choose to move forward with WSL, we recommend using VSCode as your text editor (we will get into text editors later), running with the “Remote - WSL” extension. This allows you to open your WSL files directly in the editor. The Linux subsystem is completely separate from your Windows subsystem and you will have to manually link them together otherwise.
The Odin Project has great support for Linux/MacOS if you get stuck, so please give it a shot! If you feel you can contribute and support Windows at The Odin Project, please create a PR with Windows installation directions, and fixes for wherever the Windows commands might differ from Linux.
If you’d like to move forward with WSL, despite the warning above, please see below for installation instructions.
Microsoft has made installing WSL super simple.
This will install WSL on your computer. The process will take about 10 minutes to complete, depending on your internet connection.
Note: If you run into an error, follow the directions here to enable and install WSL.
WSL is nothing more than a Linux terminal inside Windows. To start the program, simply open your Start menu and search for “Ubuntu 18.04”. The first time you run the program, you may get a message that says, “Installing. This may take a few minutes…” When it finishes, you will be asked to create a new username and password that will be used to log into WSL.
You can skip all of the following steps if you will be using VSCode with the “Remote - WSL” extension
When Ubuntu was set up, your Windows file system (C:\ drive) was mapped to the
/mnt directory in Ubuntu. To make your life much easier, we are going to set up a shortcut between your C:\ drive and your “Home” folder inside WSL.
You can choose to put your project files anywhere you want, but to make your life easier, we recommend adding a Projects folder inside your Documents folder.
From inside the Ubuntu terminal, type:
mkdir /mnt/c/Users/<Your Windows Username>/Documents/Projects
Be sure to replace
<Your Windows Username> with your Windows username in the above code.
Next, we’re going to establish a link to connect this new Projects folder to your WSL “Home” directory. This is important for many behind-the-scenes processes.
Inside the Ubuntu terminal, type:
ln -s /mnt/c/Users/<your windows user name>/Documents/Projects ~/Projects
Any projects created from the WSL terminal need to be placed inside the Projects directory.
Open all of your projects through the terminal.
The WSL program files are well hidden, but it’s super important that you do not edit these files from Windows. Altering these files will cause serious problems with your Ubuntu installation and possibly with your Windows installation. </details>