Skip to content

[English] How to install and run Catarse

runeroniek edited this page Feb 20, 2013 · 10 revisions

How to install Catarse on my machine?

Ok, there are a few (but small) steps to run catarse on your machine, even if it is a Windows-based one.

NOTE: This will take some minutes to go depending on your configurations. The whole process can take more than 10 minutes if your connection is slow. But, for your happiness, this only happens on the first run. After that, everything will be amazingly fast.

1 - Download Vagrant

  • You have to download Vagrant for your specific system.

  • For instance, I'm a mac user, so I have to download the Vagrant.dmg file on the list. If you're a Windows user, you have to choose the Vagrant.msi and so on. Every download has its own OS symbol on the left.

  • The link to download is here: http://downloads.vagrantup.com/

  • The first on the list is the more recent version

2 - Install Vagrant

  • Open the download
  • Just go "Next" for all steps
  • You'll asked to enter your password or administrator privileges.

3 - Download VirtualBox

  • VirtualBox is a tool to manage and create Virtual Machines (like I said, you can run other "machines" inside yours).

  • You need to download for your specific Operational System. For instance, "OS X host" on the downloads list means Mac OS X, "Windows Hosts" means Microsoft Windows and "Linux Hosts" means Ubuntu, Debian and so on.

  • Download it here: https://www.virtualbox.org/wiki/Downloads

4 - Install VirtualBox

  • Open the download
  • Just go "Next" for all steps
  • Probably the installation will require administrator privileges, so if asked to type your password, you can trust.

5 - Open the terminal application

Linux

  • Open the "terminal" application.

Mac

  • Go to spotlight and search for "terminal". Open it.

Windows

6 - Running the Machine

  • Inside the catarse/ directory, type vagrant gem install librarian
  • Type vagrant gem install vagrant-vbguest to keep the VM shared connection updated
  • After the successful installation of these gems, type vagrant up
  • This command will download a virtual machine and install some essential packages.

7- Provisioning

  • Type vagrant provision to install some tools to help you run Catarse's code.

8 - Access the fully functional and running Catarse

  • Open your favorite web browser and go to http://localhost:3000. Voalá. Catarse is running.

9 - Edit Files

  • Open your favorite editor or IDE, make modifications and commit it to your own server. Any modifications you do on your machine is reproduced on the Virtual one. Just edit your local files.

  • If you need to run tests or others, run vagrant ssh and then cd vagrant/ to enter the Catarse directory on the Virtual Machine.

  • On windows you'll need Putty for this.

Need help on other areas?

  • There are other wikis to help you commit to your server or just make a pull request.
  • Go to "Wiki" link above and go for a ride.