Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/oddhill/oddboxen

Development environment used at Odd Hill, forked from Boxen.
https://github.com/oddhill/oddboxen

Last synced: 2 months ago
JSON representation

Development environment used at Odd Hill, forked from Boxen.

Awesome Lists containing this project

README

        

# DEPRECATED

This environment has been deprecated in favor for [Odd Environment](https://github.com/oddhill/oddenvironment). Why? Simply because we needed an environment which is easier to maintain, and Boxen contains a lot of additional stuff which we simply don't need.

Head over to [the project page for Odd Environment](https://github.com/oddhill/oddenvironment) for migration instructions.

# Odd Boxen

Odd Boxen is a web development environment for OS X based on [GitHubs Boxen](http://boxen.github.com).

This will automatically point any .dev domain to your locahost and enable dynamic virtual hosts for every folder in your ~/Sites folder. This means that you'll be able to setup a site by creating a folder, *example*, in your ~/Sites folder and access it from http://example.dev, or https://example.dev if you want to use a secure connection.

## What's included?

This is a list that points out the most relevant parts for this development environment. For a full list and further information, please refer to the repository for [our-boxen](https://github.com/boxen/our-boxen).

* Homebrew
* PHP 5.4
* MySQL
* MongoDB
* Solr
* Git
* Node.js
* Grunt CLI
* Gulp
* Bower
* Yeoman
* JSHint
* Ruby
* Sass
* Drush
* Registry Rebuild
* Module Builder
* Apache configuration
* Dynamic document root
* Support for HTTPS
* Postfix relay for Sendgrid

## Prerequisites

If you have any installations that are included within Odd Boxen, make sure that they are completely uninstalled before you continue. Don't forget to backup any personal data, such as MySQL databases, before you uninstall these services!

## Installation

1. Install Xcode Command Line Tools:

```
xcode-select --install
```
This will ask for your password, and initiate the installation if needed. All you need to do is to follow the instructions.

2. Install [Xcode](https://itunes.apple.com/us/app/xcode/id497799835?ls=1&mt=12), and start Xcode in order to approve to the terms of use.

3. Run the following commands exactly as they say:

```
sudo mkdir -p /opt/boxen
sudo chown ${USER}:staff /opt/boxen
git clone https://github.com/oddhill/oddboxen.git /opt/boxen/repo
cd /opt/boxen/repo
```

4. Create the Sendgrid manifest:

```
cp puppet-postfix/manifests/sendgrid.pp.default puppet-postfix/manifests/sendgrid.pp
```

5. Edit the Sendgrid manifest with your favorite editor, e.g:

```
pico puppet-postfix/manifests/sendgrid.pp
```

Enter the credentials for your [Sendgrid account](https://sendgrid.com).

6. Install Odd Boxen:

```shell
# Install lamp
script/boxen lamp

# To install things you need when developing mean apps.
script/boxen mean
```

Expect this to take a while.

7. When you're back at the prompt, restart the shell, and you should be able to run `boxen --env`. This will display the current status of the environment.

If you can't run `boxen`, you'll need to add this line to the end of your *~/.profile* or *~/.bash_profile*:

```
source /opt/boxen/env.sh
```
Then restart your shell, and try to run `boxen --env` again.

## Install apps
Install some common applications via boxen through `brewcask`.

```shell
boxen dev-apps
boxen common-apps
```
[List of dev-apps](https://github.com/oddhill/oddboxen/blob/master/modules/projects/manifests/dev-apps.pp)
[List of common-apps](https://github.com/oddhill/oddboxen/blob/master/modules/projects/manifests/common-apps.pp)

## Updating

1. Run `brew update && brew upgrade` in order to update and upgrade all formulas and brews.

2. Run `boxen` from the terminal. This will automatically pull the latest changes from this repository, and perform any required alterations.

## Known issues

* Please check the [issue queue](https://github.com/oddhill/oddboxen/issues) for known issues.
* If you experience any problems please [file an issue](https://github.com/oddhill/oddboxen/issues/new). Make sure to read the [Troubleshooting](#troubleshooting) section first though, as this may solve your problems.

## Troubleshooting

* Run `brew update && brew upgrade` in order to update and upgrade all formulas and brews.

* Run `brew doctor` in order to check for any errors related to Homebrew. Take any actions necessary.

* Make sure that Xcode is updated. Check the App Store for available updates.

* Run `xcode-select --install` in order to update Xcode Command Line Tools.

## Upgrading from 10.10 to 10.11

After upgrading to 10.11 you need to do the following to get boxen working:

1. Make sure `command line tools` is up to date. Check app store for updates.
2. Install bundler `cd /opt/boxen/repo && sudo gem install bundler`
3. Run `boxen lamp` to fix the Apache configs.