Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to install instructions #492

Open
wants to merge 1 commit into
base: staging
Choose a base branch
from
Open
Changes from all commits
Commits
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
113 changes: 64 additions & 49 deletions docs/sources/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,72 @@

Here are some requirements and guides to contributing to the Girl Develop It website code base. Be sure to review this when trying to install a local development environment! Be sure to reach out to us at [[email protected]](mailto:[email protected]) with questions.

There are two ways to install the website on your local machine. We reccomend you use our Vagrant environment. This is a pre-packaged, configured development environment that includes a virtual machine. These instructions will work on Windows, Mac, or Linux machines.
Copy link
Collaborator

Choose a reason for hiding this comment

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

typo -- recommend


---

### How to Vagrant

<!-- To set up the Vagrant environment locally:

1. Install VirtualBox
2. Install Vagrant
3. clone the git repository
4. `$ vagrant up`
5. `$ vagrant ssh`
6. `$ cd /opt/gdi/development`
7. `$ bundle install`
8. `$ rake db:create db:migrate db:seed`
9. `$ bin/rails s`
10. Point your browser to `localhost:3000`
11. DEVELOP IT! \o/ -->
Copy link
Collaborator

Choose a reason for hiding this comment

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

Refresh my mind -- we decided to keep this but commented out?


#### 0. Install Git (Windows only)
Git is a cross-platform tool that helps users collaborate on code projects. We use Git, combined with the site GitHub, to manage our website. Windows users will need to install Git on their machines. You can the latest version from [Git for Windows](https://git-for-windows.github.io/)
Copy link
Collaborator

Choose a reason for hiding this comment

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

"You can the latest version..."


Vagrant cannot run properly inside Powershell, so powershell-based tools like [GitHub Desktop](https://desktop.github.com/) won't work for Windows users.

#### 1. Install VirtualBox
VirtualBox is a cross-platform virtualization application (see: [the VirtualBox manual](https://www.virtualbox.org/manual/ch01.html)). That means it can install multiple virtual machines at the same time, which is great for development. You can download the latest version on [the VirtualBox website](https://www.virtualbox.org/wiki/Downloads).

If you have an older version of VirtualBox on your machine, be sure to update it. Version 5.0.12 and below won't work with this setup.

#### 2. Install Vagrant
Vagrant is a wonderful tool to help you build complete development environments. Download the latest version on [the Vagrant website](https://www.vagrantup.com/downloads.html).

#### 3. Clone the gdi-website Git repository
Clone the Git repository into your local development folder: `[email protected]:girldevelopit/gdi-website.git`

#### 4. Start Vagrant
Depending on your machine, this could take a while.

```
$ vagrant up
$ vagrant ssh
```

#### 6. Install and initialize the development environment

Run the following:

```
$ cd /opt/gdi/development
$ bundle install
$ rake db:create db:migrate db:seed
$ bin/rails s
```

Again, this could take several minutes to run.

#### 7. View website
Test your connection in a browser: `localhost:3000`

---

##Manual Installation

If you prefer not to use Vagrant, you can manually install the site on your local machine. This instructions will only work for machines running Mac OS X or above.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Still certain I got this working for PC (the Gemfile has conditions for OS types), but I can help add more details since there are things to comment out/change in the database.yml file if a person decides to go the manual route.


### Required installations
* [homebrew](http://brew.sh/), a package manager for Mac OS X.
* [rvm](http://rvm.io/), a command-line tool to manage different versions of Ruby.
Expand Down Expand Up @@ -113,52 +177,3 @@ sudo apt-get install build-essential libpq-dev imagemagick libmagickwand-dev no
postgres=# CREATE ROLE <username> SUPERUSER LOGIN;
postgres=# \q
```

---

### How to Vagrant

<!-- To set up the Vagrant environment locally:

1. Install VirtualBox
2. Install Vagrant
3. clone the git repository
4. `$ vagrant up`
5. `$ vagrant ssh`
6. `$ cd /opt/gdi/development`
7. `$ bundle install`
8. `$ rake db:create db:migrate db:seed`
9. `$ bin/rails s`
10. Point your browser to `localhost:3000`
11. DEVELOP IT! \o/ -->

#### 1. Install VirtualBox
VirtualBox is a cross-platform virtualization application (see: [the VirtualBox manual](https://www.virtualbox.org/manual/ch01.html)). That means it can install multiple virtual machines at the same time, which is great for development. You can download the latest version on [the VirtualBox website](https://www.virtualbox.org/wiki/Downloads).

#### 2. Install Vagrant
Vagrant is a wonderful tool to help you build complete development environments. Download the latest version on [the Vagrant website](https://www.vagrantup.com/downloads.html).

#### 3. Clone the gdi-website Git repository
Clone the Git repository into your local development folder: `[email protected]:girldevelopit/gdi-website.git`

#### 4. Start Vagrant
Depending on your machine, this could take a while.

```
$ vagrant up
$ vagrant ssh
```

#### 6. Install and initialize the development environment

Run the following:

```
$ cd /opt/gdi/development
$ bundle install
$ rake db:create db:migrate db:seed
$ bin/rails s
```

#### 7. View website
Test your connection in a browser: `localhost:3000`