Skip to content
Vinod Panicker edited this page May 18, 2016 · 27 revisions

OpenAppHack

Join the chat at https://gitter.im/WiproOpenSourcePractice/openapphack

Openapphack is an opensource application aggregrator.

Openapphack and its subprojects help aggregate ,validate and test github repositories that derived from openapphack-vm, openapphack-cluster, openapphack-pi-vm, openapphack-pi-cluster repositories

Openapphack also enables end to end automation of application deployment which can be leveraged for prototyping and distributed deployment of opensource applications .

Openapphack uses opensource tools for provisioning , code authoring and scaffolding.

Openapphack-vms/clusters leverages vagrant, ansible ,yeoman,virtualbox and docker for automation.

The goal is to get a collection of fully functional , opensource apps working on the openapphack-vm or openapphack-cluster that can be customized using plain yaml files.

The broader purpose is to provide a simplified path for full stack developers to quickly get started on opensource technologies and experiment freely on opensource applications

Index

What is OpenAppHack Project?

An openapphack project is a git repository derived from one of the openapphack vm or cluster project templates

The project templates are

  • openapphack-vm : Template used for setting up a single openapphack vm.
  • openapphack-pi-vm :Template used for setting up a single openapphack vm on RPI's.
  • openapphack-cluster : Template used for setting up multi or load balanced/ HA cluster for the application.
  • openapphack-pi-cluster : Template used for setting up multi or load balanced /HA cluster on openapphack RPI cluster.

All openapphack projects github repositories must follows a naming convention and github repository names must end with either an xxx-vm, xxx-pi-vm ,xxx-pi-cluster or xxx-cluster to be picked up by the openapphack for analysis and testing.


Openapphack subprojects and repositories

The others repositories used by the openapphack project are listed below:

Openapphack-vm : The repository from which all openapphack-xxx-vm repos are derived.

Openapphack-cluster : The repository from which all openapphack-xxx-cluster repos are derived..

Openapphack-ansible-roles : Repository used to organize all openapphack ansible roles . These can be used by openapphack projects, You can also add your own ansible roles that work on openapphack-vm

Openapphack-yeoman-generators : Repository used to organize all yeoman generators used by openapphack vm/clusters. You can also add your own yeoman generators that work on openapphack-vm, more info

Openapphack-stats : The repository that will be updated periodically with test results and details from validated openapphack-vm/clusters..


Contributing to this project

You can start contributing to this project by starting your own openapphack-vm or openapphack-cluster project as mentioned below.

How do you start your openapphack project?

You begin by forking an openapphack-vm and follow the instructions mentioned here

How do you customize your openapphack-project?

You are free to tweak the vm configurations as long as the base vagrant box and the openapphack vm folder structure is maintained. Any additional customization must be done only in the yaml files.

You are also free to add (only add) and include your own yeoman generator and ansible roles as long as they work together on the openapphack-vm.

Please take a look here , on how to add your own openapphack ansible role

Please take a look here , on how to add your own openapphack yeoman generator

How do you test your openapphack-project?

clone your openapphack-vm associated with your githubid or org and run vagrant up , vagrant provision.

You should be able to validate and test your vm.

How do you submit your openapphack-project?

You will have to submit a pull request to openapphack repository to do so.

If you are unsure on how to make a pull request. Please refer github's guide on creating a pull request

Do mention your github repository url and details of any ansible or yeoman generators you have included to get your openapphack project working.

Please join the community @ https://groups.google.com/forum/#!forum/openapphack.

If you have any questions/suggestions please email to [email protected]

Interested in going the extra mile :

If you want to contribute to the development of openapphack main project please do take a look at the issues

You can get details on the branching model that will be followed [here] (http://nvie.com/posts/a-successful-git-branching-model/) ,

License

This project is licensed under the MIT open source license.

Credits

Still compiling this.. Lot of Folks to thank, we are standing on the shoulders of a lot of excellant programmers and a lot of opensource projects.

here is a list..