3/oss start (#17)

* #3: updated readme + docs + build integration + templates + rest

.github/ISSUE_TEMPLATE/bug_report.md

@@ -17,18 +17,11 @@ Steps to reproduce the behavior:
 **Expected behavior**
 A clear and concise description of what you expected to happen.
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+**Terminal output**
+If applicable, add temrinal output to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
+ - OS: [e.g. iOS / MacOS / Android / Linux]
  - Version [e.g. 22]
 
 **Additional context**

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,11 +1,11 @@
 ---
 name: Feature request
-about: Suggest an idea for this project
+about: Suggest an idea or improvement for this project
 
 ---
 
 **Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+A clear and concise description of what the problem is. 
 
 **Describe the solution you'd like**
 A clear and concise description of what you want to happen.

.travis.yml

@@ -0,0 +1,38 @@
+---
+sudo: required
+language: objective-c
+# 10.13 (see https://docs.travis-ci.com/user/osx-ci-environment/#OS-X-Version)
+osx_image: xcode9.3
+
+before_install:
+  # Uninstall existing Homebrew installation.
+  - curl -sLO https://raw.githubusercontent.com/Homebrew/install/master/uninstall
+  - chmod +x ./uninstall
+  - ./uninstall --force
+  - sudo rm -rf /usr/local/Homebrew
+  - sudo rm -rf /usr/local/Caskroom
+  - sudo rm -rf /usr/local/bin/brew
+
+install:
+  # Install pip.
+  - sudo easy_install pip
+
+  # Install Ansible.
+  - sudo pip install ansible
+
+  # Add ansible.cfg to pick up roles path.
+  - "{ echo '[defaults]'; echo 'roles_path = ../'; } >> ansible.cfg"
+
+  # Add a hosts file.
+  - sudo mkdir -p /etc/ansible
+  - sudo touch /etc/ansible/hosts
+  - "echo -e '[local]\nlocalhost ansible_connection=local' | sudo tee -a /etc/ansible/hosts > /dev/null"
+
+script:
+  # Install dependencies.
+  - "ansible-galaxy install -r requirements.yml"
+
+  # Check the playbook's syntax.
+  - "ansible-playbook $TRAVIS_BUILD_DIR/generic/generic_items.yml --syntax-check"
+  - "ansible-playbook $TRAVIS_BUILD_DIR/iOS/generic_items.yml --syntax-check"
+  - "ansible-playbook $TRAVIS_BUILD_DIR/Android/generic_items.yml --syntax-check"

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,6 @@
+Thank you for submitting a Pull Request to the Mobile Security hacking tools. Please make sure that:
+
+- [ ] If your PR is related to an issue. Please end your PR test with the following line: This PR covers issue #<issue_number_here>.
+- [ ] If you install a new tool, that the value of the tool is explained in teh pr + docs
+- [ ] If you install a new tool, that it is installed in the right folder
+- [ ] If you update an installer, that it is functional

README.md

@@ -1,28 +1,33 @@
 # Mobile Security Toolchain
 
+[![Build Status](https://travis-ci.org/xebia/mobilehacktools.svg?branch=master)](https://travis-ci.org/xebia/mobilehacktools)
+
 This is the mobile security toolchain project. It is loosely based on the MSTG testing tools section (https://github.com/OWASP/owasp-mstg/blob/master/Document/0x08-Testing-Tools.md).
 
+## Current status
+The project is in early beta stage. Feel free to contribute!
+
 ## Pre-requisites
-Have a mac os X based system with about 4 GB of RAM and 4 GB of free space. Next, install docker for mac on it and then:
+Have a Mac OSX based system with about 4 GB of RAM and 4 GB of free space. Next, install docker for mac on it and then:
 
 - if you want to have both the iOS and android tools, as well as all the scaffolding, just use `./install.sh`
 - if you want to have the ios tools only: install brew and ansible, then type:
 ```sh
-ansible-galaxy install geerlingguy.homebrew
-ansible-galaxy install geerlingguy.mas
-ansible-galaxy install rvm_io.ruby
+ansible-galaxy install -r requirements.yml
 ansible-playbook -K ./iOS/generic_items.yml
 ```
 
-- if you want to have the ios tools only: install brew and ansible, then type:
+- if you want to have the Android tools only: install brew and ansible, then type:
 ```sh
-ansible-galaxy install geerlingguy.homebrew
-ansible-galaxy install geerlingguy.mas
+ansible-galaxy install -r requirements.yml
 ansible-playbook -K ./Android/generic_items.yml
 ```
 
 ## Contribution
 Does something not work? File an issue, better: file a pull-request!
 
 ## Special thanks to:
-@clviper & @sushi2k for contributing (review) & @RiieCco for motivating me to get the project started.
+[@clviper](https://github.com/clviper) & [@sushi2k](https://github.com/sushi2k) for contributing (review) & [@RiieCco](https://github.com/RiieCco) for motivating me to get the project started.
+[@geerlingguy](https://github.com/geerlingguy) for creating awesome Ansible roles that speeded up the development tremendously.
+Xebia, as a company from which I used an innovation day to kickstart the project.
+My wife for supporting me in doing mobile security open source projects in my spare time.

install.sh

@@ -13,14 +13,10 @@ fi
 echo "Installing Ansible"
 brew list ansible|| brew install ansible || brew link --overwrite ansible
 
-
 echo "installing necessary roles"
-ansible-galaxy install geerlingguy.homebrew
-ansible-galaxy install geerlingguy.mas
-ansible-galaxy install rvm_io.ruby
+ansible-galaxy install -r requirements.yml
 # ansible-galaxy install geerlingguy.dotfiles
 
-
 echo "running toolchain for generic items"
 ansible-playbook -K ./generic/generic_items.yml
 

requirements.yml

@@ -0,0 +1,4 @@
+---
+- name: geerlingguy.dotfiles
+- name: geerlingguy.homebrew
+- name: geerlingguy.mas