Skip to content
This repository was archived by the owner on Dec 3, 2019. It is now read-only.

added instructions for running dev env in a VM #272

Closed
kirbyfern wants to merge 1 commit into from
Closed

added instructions for running dev env in a VM #272

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,72 @@ Docker is a container system. Click the appropriate link below to install Docker

Note that a full installation of the Docker Toolbox includes Git as well, which is also needed to work on the backend and is mentioned below.

### Virtual Machine (AWS)

@hpjaj hpjaj Mar 17, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just created a new dedicated section for these AWS Virtual Machine instructions to live under. You will need to rebase on master to see them.

Please follow the pattern in PR #277, and relocate these instructions to a new dedicated file called aws_vm_setup.md.

@kirbyfern kirbyfern Mar 18, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok got it

A virtual machine is a software computer that, like a physical computer, runs an operating system and applications.

## Create AWS VM
(Using Ubuntu 16.04 on AWS)
Make sure to open these ports in your security group
- Port 22
- Port 3000
When the VM spins up, SSH into it.

##
(from your VM)
Fork https://github.com/operationcode/operationcode_backend

```bash
git clone https://github.com/[YOUR-GITHUB-NAME]/operationcode_backend.git

cd operationcode_backend

git remote add upstream https://github.com/OperationCode/operationcode_backend.git

sudo apt-get install make
```

## Install Docker
```bash
sudo apt-get update

sudo apt-get install \
apt-transport-https \
ca-certificates \
curl \
software-properties-common

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

sudo add-apt-repository \
"deb [arch=amd64] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) \
stable"

sudo apt-get update

sudo apt-get install docker-ce
```

## Install Docker Compose

```bash
sudo curl -L https://github.com/docker/compose/releases/download/1.19.0/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
```

## Setting up the Dev Environment
```bash
sudo make setup
```

(if you want to try running the tests, run this command)

```bash
sudo make test
```

Now navigate to http://<vm_public_ip>:3000 and you should see the "You're running on Rails" page!

### Git
Git is a distributed version control system. This is how our code is stored and managed. Git can be frustrating, but it is an essential tool. If you want to learn more about Git, a great resource is [Think Like a Git](http://think-like-a-git.net/). If you find yourself in a real git pickle, see ["Oh, shit, git!"](http://ohshitgit.com/). If you have already installed Git as a part of the Docker Toolbox, you don't need to install it again using the following link.

Expand Down