Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/bltavares/baseline

Dev box with batteries included
https://github.com/bltavares/baseline

Last synced: 28 days ago
JSON representation

Dev box with batteries included

Awesome Lists containing this project

README 

        
# Baseline

## Dev box with batteries



The idea is to provide a simple dev box with tools.



Sometimes you want to play with a project, which leads you to install a lot of stuff on your computer and the filesystem gets messy.

Booting your computer begins to slow, because it is loading a database that you never use.

Maybe you want to try out a language but it requires you to install all the libraries and compilers.



Now you can mess up all the files in your dev box, and discard when you think it is too messy.



#### Video cast

_Click to watch a live example of baseline_



[![Video Cast](http://i.imgur.com/DKy7Huj.png)](http://showterm.io/ff5b0a53bdc8a70d7d5b8)



### Table of contents

  - [Requirements](#requirements)

  - [Installation](#installation)

  - [Commands](#commands)

  - [List of environments](#list-of-environments)

  - [Using GUI programs](#using-gui-programs)

  - [Extending with your own puppet scripts](#extending-with-your-own-puppet-scripts)

  - [Debugging](#debugging)



### Requirements



* [Vagrant](http://vagrantup.com)

* Internet connection

* git



### Installation



#### Debian/Ubuntu



```bash

wget https://github.com/bltavares/baseline/releases/download/1.3.0/baseline_1.3.0_all.deb

sudo dpkg -i baseline_1.3.0_all.deb

```



#### Mac (Homebrew)



```bash

brew tap bltavares/tap

brew install baseline

```



#### Manual installation



Make sure you have vagrant installed and configured on your machine.



```bash

# Adjust the paths to your preferred location

installation_path=/opt/baseline

shell_configuration=$HOME/.bashrc



git clone https://github.com/bltavares/baseline.git $installation_path

echo 'export PATH=$PATH:'$installation_path'/bin' >> $shell_configuration

```

This command will clone this repo to /opt/baseline by default and add it to your PATH, so the command can be found.

Then it will add some autocomplete for you.



Don't worry too much about cloning it into /opt/baseline. Clone it wherever you want, but put that onto your path. One idea is to clone it somewhere, then symlink it to a place on your path.



### Autocomplete



To enable autocompletion run the following command:



```bash

shell_configuration=$HOME/.bashrc

echo 'eval "$(baseline autocomplete)"' >> $shell_configuration

```



Adjust the shell configuration variable if you use a different shell.



### Commands



#### init - Create a new box in the project dir



```bash

baseline init [ [ [branch name. default to "master"]]] 



# example

cd awesome-project

baseline init .



# another example

baseline init awesome-project https://github.com//vagrant-baseline.git awesome-code

cd awesome-project

```



#### up - Bring a box up with some configuration



```bash

baseline up []

```

- Arguments:

  - environments: optional list of enviroments to start the box with. If no argument is passed, it will come up with the last configuration used.



e.g.:

```bash

baseline up ruby nodejs

```



#### ssh - Connect to the box

```bash

baseline ssh

```



#### provision - Provision a running box with the specified environments

```bash

baseline provision 

```



#### reload - Reload the box configurations

```bash

baseline reload

```



#### halt - Halt the box

```bash

baseline halt

```



#### destroy - Destroy the box

```bash

baseline destroy

```



#### remove - Destroy the box AND removes .baseline

```bash

baseline remove

```



#### update - Update the box recipes

```bash

baseline update

```



#### dotfiles

```bash

baseline dotfiles  

```

- Arguments:

 - git url for the dotfiles: The url to clone dotfiles from



This command will change the configurations to point to your own dotfiles.

Then use the environment `dots` to have it installed in your box.



Eg:

```bash

baseline init

baseline dotfiles 

baseline up dots nodejs

```



The dofiles project must have some constraints. Check the [instructions](https://github.com/bltavares/vagrant-baseline#using-your-own-dotfiles).



#### upgrade

```bash

baseline upgrade

```

Upgrade baseline to the latest version



#### envs

```bash

baseline envs

```

List the environments supported by the current baseline project



#### version

```bash

baseline version

```



#### exec - Executes the command on vagrant on the .baseline folder

```bash

baseline exec rsync

```



### List of environments



Currently baseline is only supporting [vagrant-baseline](https://github.com/bltavares/vagrant-baseline) vagrant setup.

You can check the list of supported environments [here](https://github.com/bltavares/vagrant-baseline#current-environments).



### Using GUI programs



Ssh allows you to forward the X server to your computer. If you want to use a program with a graphical interface or want to code an app that generates graphics, you can ask `vagrant` to forward it for you.



Just ssh with the following command:

```bash

baseline ssh -- -X

```



### Extending with your own puppet scripts



Sometimes you will want to try out some different modules that are not currently in the project. Perhaps you want to set up a webserver for the project you are writing and have it configured and deployed with your project. Or maybe you just want to have some packages installed, or removed.



You can achieve that by extending the project using the _.baseline/puppet/custom_ folder. There is an example file to guide you in extending your vagrant machine.



### Packaging



#### .deb

You need to have make and fpm installed.



```bash

make deb

```



### Debugging



When building puppet scripts, a verbose output can help. In those cases we provide the `DEBUG` variable to increase the output, show debug messages and create dependency graphs.



```bash

DEBUG=1 baseline up redis

```