plants

🌱 Before you get going 🌱

Make sure you have installed Vagrant and Virtual Box 5.1

If you have the dependencies for this project, pop open a terminal (ctrl-alt-t for all you nasty neck-beards) and get ready to copy-pasta some commands.

Download the project:

git clone https://github.com/gu-app-club/plants.git
cd plants

Using Vagrant, build the development environment (this will not work if you don't have Vagrant and Virtual Box installed).

If you are using Windows, run ALL Vagrant commands as administrator

vagrant up

Some fancy text will start scrolling down matrix style. If you are in a public area with an audience, this is a great opportunity to full-screen your terminal and rollplay as 4chan, the internet's greatest hacker.

Awesome? No errors? Perfect! Just...

vagrant ssh

Vagrant gives you access to a virtual machine. The last command just let you ssh into it.

In the Vagrant environment move into the project folder. This is a shared directory with the GitHub repository.

cd plants

🌵 Running the webserver 🌵

Soooo close!!

vagrant@vagrant:/~plants$ yarn install

To run the webserver:

vagrant@vagrant:~/plants$ yarn run start

If there are no warnings, you should be able to navigate to localhost:3000 and view the project.

Useful vagrant commands to know!

After running a version of plants on your machine, then pulling to get the latest update, you'll need to use this command to update the vagrant VM.

vagrant@vagrant: vagrant provision

Logging out of the vagrant enviorment:

vagrant@vagrant: logout

🍃 Got everything setup? Nice job! Go check the issues page to get started. 🍃