Get Started with Phantdom

How to Build Ruby on Rails Apps with Phantdom MacOS Desktop App



In order for Phantdom to work properly, you will need a few things installed on your computer. The following will be a guide to get you started working with Phantdom with ease.

First... What is Phantdom?

At it’s core, Phantdom is a database blueprint builder

What does that mean? If you are new to the world of "database schema migrations" then you can think of them as blueprints for your database.

In Ruby on Rails the database is moved from your local machine to the cloud/server. Instead of handing over the entire database to the cloud, we just send them the blueprint and it gets rebuilt there.

In Ruby on Rails this is known as "Schema Migrations." We made Phantdom in order to make sense of the critical component in building a high class application.

Let's install the PostgreSQL which which will power your database.

Before We Begin: Open Mac Terminal

In order to complete the necessary steps to make sure you have what you'll need to use Phantdom, you will first need to open Terminal.

Mac Terminal Icon

To find your Terminal app, you can type "Terminal" into Spotlight search, or...

Go to /Applications/Utilities/Terminal in Finder.

Step #1: Install The Necessary Dependencies

a) Install Homebrew:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

For more information on Homebrew, we recommend checking out the offical site here.


b) Install rbenv:

Click here for full instructions on installing rbenv


c) Install Ruby Version Manager (RVM):

Click here for full instructions on installing RVM


d) Verify you have Git installed on your machine.

git --version

All Macs come with Git installed by default. But, if for some reason your machine does not: the easiest way to install Git is to install the XCode Command Line Tools. Which we will then do in Step 2...

Step #2: Turn Ruby On...

Before you start thinking dirty, we need to make sure we can use Ruby on your computer. Ruby is a programming language which is very easy to learn. Ruby is also installed by default on Mac.

If you do not already have a Rails app ready to use with Phantdom, we'll need to make sure you have XCode installed on your computer to run terminal commands.

Next, make sure to install XCode command line tools by running this line in the Mac Terminal:

xcode-select –install

You can also get XCode via the Apple Store, however you only need "xcode-select" to run Ruby commands. Once installed, you can run the following code in terminal you are ready to setup Ruby on Rails:

ruby -v

Let's build your first Rails application quickly.

Step #3: Your First Ruby on Rails App

Start by opening the Mac Terminal and install Rails:

gem install rails

Now you can create a new Rails application, with PostgreSQL as the database:

rails new your_app_name –d postgresql

This line will tell Rails to build the application using PostgreSQL which is required for Phantdom.

You can now return to your Terminal application and create the databases for your app using the following command:

rake db:create

You can then change into the new app directory.

cd your_app_name

And start the Rails server:

rails server

You can visit your rails application in the browser by going to http://localhost:3000. At this point you are ready to start using Phantdom effectively and unleash it's full power!

To learn more about Rails, Active Record, and generating database migrations, we recommend checking out the Ruby on Rails official guides.

Step #4: Start Using Phantdom Desktop App

Right now we are in the first stage of beta release. We are working on writing documentation for every part of the app. Expect this part of the guide to change in the near future!

Need More Help?

If you ran into any errors during these steps with PostgreSQL or Ruby on Rails you can check out the curated resource list below:

You can learn more about Phantdom at the documentation page or drop us a message using the Intercom chat box on any page. We look forward to hearing from you!

We do not provide support for Ruby on Rails or PostgreSQL we only provide support for using Phantdom desktop app.

Did we miss anything?

Let us know in the comments