Checkpoint 4 review

.coveragerc

@@ -0,0 +1,10 @@
+[report]
+omit =
+    *virtualenv*
+    *envs*
+    *migrations/*
+    */python?.?/*
+    *__init__*
+    */tests/*
+    *manage.py
+    *settings.py

.gitignore

@@ -60,3 +60,10 @@ target/
 
 #Ipython Notebook
 .ipynb_checkpoints
+
+# exclude ssl cert and key
+*.crt
+*.key
+
+# coveralls config file
+*.coveralls.yml

.travis.yml

@@ -0,0 +1,16 @@
+language: python
+python:
+    - "3.5"
+install: pip install -r requirements.txt
+env:
+  global:
+    - TRAVIS_BUILD=true
+script:
+    - coverage run --append manage.py test tests
+branches:
+  only:
+      - master
+      - develop
+      - feature/app
+after_success:
+    - coveralls

Procfile

@@ -0,0 +1 @@
+web: gunicorn phedit.wsgi --log-file -

README.md

@@ -1,20 +1,64 @@
+[![Build Status](https://travis-ci.org/andela-cmutembei/IV.svg?branch=develop)](https://travis-ci.org/andela-cmutembei/IV)
+[![Coverage Status](https://coveralls.io/repos/andela-cmutembei/IV/badge.svg?branch=develop)](https://coveralls.io/github/andela-cmutembei/IV?branch=develop)
+[![Code Issues](https://www.quantifiedcode.com/api/v1/project/9e68169eaae44b4ea781295f597949dd/snapshot/origin:develop:HEAD/badge.svg)](https://www.quantifiedcode.com/app/project/9e68169eaae44b4ea781295f597949dd)
+
 ## [PHEDIT](https://phedit.herokuapp.com)
 
 > A picture is worth a thousand words - [English idiom](https://en.wikipedia.org/wiki/A_picture_is_worth_a_thousand_words)
 
-Phedit is a modern photo editing application that lets you express yourself through pictures. This project in still in development, you can view the project plan [here.](https://goo.gl/5zVk0I)
+Phedit is a modern photo editing application that lets you express yourself through pictures. Users can upload images to Phedit and apply any of the close to a dozen effects. The edited images can be shared to facebook or twitter through a public url. To view what other people have shared as well as share your edits on twitter use the hashtag [#phedited](https://twitter.com/search?f=tweets&q=%23phedited%20since%3A2016-02-23%20include%3Aretweets&src=typd)
+
+#### Depedencies
+Phedit is built using the following technologies:
+- [Django](https://www.djangoproject.com/)
+- [Django Rest Framework](http://www.django-rest-framework.org/)
+- [Pillow](http://pillow.readthedocs.org/en/3.1.x/)
+- [Postgresql](http://www.postgresql.org/)
+- [AngularJS](https://angularjs.org/)
+
+#### Installation
+To setup Phedit locally follow the following instructions:
+
+1 . Clone the repo and navigate to the project directory
+```shell
+$ git clone https://github.com/andela-cmutembei/IV.git && cd IV
+```
+
+
+2 . Install the project dependencies
+```shell
+$ pip3 install -r requirements.txt
+```
+
+3 . Create a database called `phedit` and configure the following environment variables
+```shell
+export SECRET=classified
+export DATABASE_URL=postgres://<db-username>:@127.0.0.1:5432/phedit
+```
 
-#### TODO
 
-- [ ] User can login with Facebook
-- [ ] User can view their uploaded images
-- [ ] User can upload images on the application in a non-blocking manner
-- [ ] User can edit images by applying filter and effects
-- [ ] User can share images via a public url or on facebook
+4 . Run the projects migrations and initialize the projects data
+```shell
+$ python3 manage.py migrate
+$ python3 manage.py loaddata init-data.json
+```  
+
+
+5 . Start the server for the project
+```shell
+$ python3 manage.py runserver
+```
+
+6 . Open http://127.0.0.1:8000 on your favorite web browser
+
+#### Running tests
+
+To run the projects' tests
+```shell
+$ python3 manage.py test
+```
 
 #### License
 Copyright &copy; 2016 - Collin Mutembei
 
 This project is licensed under the terms of the [MIT license.](https://github.com/andela-cmutembei/IV/blob/master/LICENSE)
-
-[![forthebadge](http://forthebadge.com/images/badges/made-with-crayons.svg)](http://forthebadge.com)

api/admin.py

@@ -0,0 +1,8 @@
+from django.contrib import admin
+from api.models.user import User
+from api.models.image import Image
+from api.models.phedited import PheditedImage
+
+admin.site.register(User)
+admin.site.register(Image)
+admin.site.register(PheditedImage)

api/apps.py

@@ -0,0 +1,9 @@
+from __future__ import unicode_literals
+
+from django.apps import AppConfig
+
+
+class ApiConfig(AppConfig):
+    """configuration for api app
+    """
+    name = 'api'