image_viewer

A mini-Python/Flask project with continuous integration testing and deployment. Try it out here - upload an image to view in browser.

dependencies

• See requirements.txt

run locally

Complete the following tasks from the command line:

In shell, from project root:

1. python setup.py install

2. start

3. Open browser to http://localhost:5000

4. After changes to source code, restart server:

• ctrl-c
• start
• refresh browser window

test

In shell, from project root:

pytest

contribution instructions

(assumes knowledge of git commands)

1. Fork repo from github.com/nzey/image_viewer
2. git clone [your_fork_url]
3. git remote add upstream https://github.com/nzey/image_viewer
4. Make your changes locally
5. Pull from upstream (in case changes have been made since you cloned) and merge with your local changes
6. Test locally (pytest)
7. Git add, commit, and push to your own fork (git push origin master)
8. Submit pull request (will trigger Travis CI build and deploy to Heroku if build succeeds)

connect Travis CI to a Github repo

(already done for this repo)

1. Go to travis-ci.org (travis-ci.com for private repos)
2. Click on 'Sign in with GitHub' in the top right
3. When account is done syncing, go to https://travis-ci.org/profile/YOUR_GITHUB_HANDLE (if not taken there automatically)
4. To activate Travis for a repository, click on the X next to the repo you want to connect
5. Add .travis.yml file to your repository

• see this project's yml for a simple example
• see Travis python specific documentation for more complex examples and additional information

6. Git add, commit, and push with new yml file to your Github repo. Check back on your Travis profile page to see build status.