jainmickey / hello-world-web

Hello World

Version: 0.1.0-dev

Add a short project description here.

Getting up and running

Minimum requirements: pip, fabric, python3 & postgres, setup is tested on Mac OSX only.

brew install postgres python3
[sudo] pip install fabric

In your terminal, type or copy-paste the following:

git clone [e-mail]:jainmickey/hello-world-web.git; cd hello-world-web; fab init

Go grab a cup of coffee, we bake your hot development machine.

Useful commands:

• fab serve - start django server
• fab deploy_docs - deploy docs to server
• fab test - run the test locally with ipdb

NOTE: Checkout fabfile.py for all the options available and what/how they do it.

Deploying Project

The deployment are managed via travis, but for the first time you'll need to set the configuration values on each of the server.

Check out detailed server setup instruction here.

How to release Hello World

Execute the following commands:

git checkout master
fab test
bumpversion release
bumpversion --no-tag patch # 'patch' can be replaced with 'minor' or 'major'
git push origin master
git push origin master --tags
git checkout qa
git rebase master
git push origin qa

Contributing

Golden Rule:

Anything in master is always deployable.

Avoid working on master branch, create a new branch with meaningful name, send pull request asap. Be vocal!

Refer to CONTRIBUTING.md