Before we can continue, we need to set up a development environment.
If you are already using MacOS or Linux, 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 “Attributes” column, beside the “Optical Drive” indicator, click the round, blue icon. This will present a drop-down menu. Click “Choose Virtual Optical Disk File…” and select the Xubuntu ISO file you downloaded earlier. If you aren’t sure where to find it, start by looking in your Downloads folder.
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. Guest Additions add a lot of functionality to the Guest OS, such as “Drag n Drop” files, full-screen guest mode, shared folders, and copy/paste between the host and guest.
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 install gcc make perlYou will be asked to type in the password you setup earlier. As you type your password, you’ll notice there is no visual feedback. This is a security measure. Trust that it is taking you input. (Just type it and then push enter). If an error is thrown, reboot the VM and try the steps in this list again.
sudo /media/$USER/VBox*/VBoxLinux*.runThis may ask you for a password as well.
rebootin the terminal, and the VM should reboot. If this does not work, reboot the VM by clicking the “start” menu, and selecting “reboot.”
devicesin the menu bar and go to
shared clipboardthen select the
NOTE: If upon trying to start the VM you only get a black screen, close and “power off” the VM, click “Settings -> Display” and make sure “Enable 3D Acceleration” is UNCHECKED, and Video memory is set to AT LEAST 128mb.
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 linux installation inside of your VM also comes with a web browser pre-installed.
To install software on your VM, you will follow the Linux 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.
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 Linux 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 Linux 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 Linux 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 highly discouraged for those unfamiliar with Linux. Specifically, those unfamiliar with with the Linux 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 rails on WSL is definitely not beginner friendly. If you have run linux dev 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.
Since the 2017 Fall Creators Update, Microsoft has made it easier to get up and running using Windows Settings and the Microsoft Store.
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.
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.
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.
Please Note: We do not support Windows without a VM or WSL at this time, as many people have had problems developing with Rails while using Windows.
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.