sample_project_template

This is a template repo that contains all the hooks needed for building, testing, continuous integration and coverage reporting. This template may be used as a baseline for creating other repos/projects on github.

Here are the steps for creating a new repo with this template as a baseline.

# Make a local copy of this repo
$ git clone https://github.com/arfathpasha/sample_project_template.git 
$ cd sample_project_template

# Copy all files from the index to the location of your new repo 
$ git checkout-index -a --prefix=../<YOUR_NEW_REPO_NAME>/
$ cd ../<YOUR_NEW_REPO_NAME>

Then follow instructions for Adding an existing project to GitHub using the command line

Your new project should now be ready to make changes to the code.

Project Status:

Build status: master:

staging:

develop:

Code coverage: (master branch)

Prerequisites:

python2.7
Virtualenv
pip
docker

Usage:

1. Create a virtual environment (if not already present)

virtualenv venv

2. Activate virtual environment

source venv/bin/activate

3. Install dependencies

pip install -r requirements.txt

4. View the various build options and exercise one of them make help

5. Deactivate virtual environment deactivate