Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Checkpoint 4 review #4

Merged
merged 59 commits into from
Mar 30, 2016
Merged

Checkpoint 4 review #4

merged 59 commits into from
Mar 30, 2016

Conversation

collinmutembei
Copy link
Owner

What does this PR do?

Creates a photo editing application with the following features

  • 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

Description of Task to be completed?

After reviewing the project with @andela-anandaa the following fixes were highlighted

  • Fix README to include all the necessary sections
  • Include more comments in code to ensure legibility and fix docstrings to match PEP8 standard
  • Ensure commit message titles are descriptive
  • Remove commented out sections of code and apply recommended styling
  • Arrange imports to match PEP8 recommended order
  • Add functionality for user to view images they have worked on in the past
  • Fix the floating menu, when on normal resolution
  • Display a progress bar to indicate image upload and when applying effects
  • Include functionality to clear image when they want to upload another image
  • Fix username/logout area to be conventional, with a dropdown menu.
  • Fix capitalization of texts

How should this be manually tested?

To test wether these fixes have been applied, visit the hosted app on heroku here

Screenshots

Screenshot will be updated in due time

- generate the project files using django-admin
- configure database and environment variables
- define custom user model extending django's
- add viewsets & serializers to define user's
  API endpoint
- update requirements.txt to cater for python3
  support using pip3
- create model for images
- add viewsets and serializers for endpoint
- update urls.py to load uploaded images
- add Procfile for heroku deployment
- update wsgi.py and requirements
- add runtime.txt to specify the python
  version to use on deployment
- add configuration to force https on
  the deployed app on heroku
- allow for user to authenticate with twitter
  and/or instagram
- configure settings to include the necessary
  keys and secrets
- remove email as a required field for users
  to work with social authentication
- update viewsets and serializers to match the
  changes in the user models
- use django-allauth for social-account authentication
  using twitter
- update migrations and requirements.txt
- mark items in todo
- update migrations
- add tests for api
- add travis CI configuration file
- update settings to use travis db when
  running tests
- add badges for travis CI, coveralls and
  quantifiedcode to the projects README.md
- add comments for classes and methods
- update travis configuration to update coverage
  after successful build
- create django powered app
- add landing page template for webapp
- update setting to point to the templates
  directory
- include libraries under template directory
- include brand on landing page, and signin
  button
- set dashboard view to render template
- configure url for dasboard
- refactor landing and dashboard views
- add tests for the landing and dashboard view
- configure travis CI to check builds on branch
- implement changes to the dashbaord template
- make a better favicon for project
- include links on footer to make users more
  aware of brand
- update url for coveralls badge on readme
- render the uploded image on edit section
- create service to perform image upload
- refactor css to have image fit edit section
- allow for users to upload images on the image
  editing secton
- include necessary libraries to help with file
  upload
- update the index.html file to load libraries
- change templates to only load app, and
  require user to login if need be
- fix tests for views to raise coverage
- include documentation for tests to fix
  complains on quantifiedcode
- use a bigger favicon
- add buttons to apply effects and save
- work on improving coverage update on coveralls
- add buttons to apply effects to images


def set_upload_file_path(instance, filename):
"""sets upload directory for users from a derivation of their uuid"""

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PEP8: For your docStrings, refer to this. The closing """ should be on it's own line.

- allow for users to clear image being edited
- hide clear and share buttons untill there is an image
- show loading dialog for process that have a latency
  on slow internet connections
- add event emitters for starting and finishing tasks
- hide upload button after upload
- restructure the positioning of the logout button
  to achieve a more conventional look
@collinmutembei collinmutembei temporarily deployed to phedit March 29, 2016 09:10 Inactive
@collinmutembei collinmutembei temporarily deployed to phedit March 29, 2016 11:33 Inactive
- allow for users to view images they have edited
- add tests for the gallery view
- remove code sections for anonymous users since
  all users have to be logged in
@collinmutembei collinmutembei temporarily deployed to phedit March 29, 2016 12:17 Inactive
- allow for user to save an edited image
- create model class, viewset and serializer for
  the saved image
- add service to save the edited image
- improve gallery template to show edited images
@collinmutembei collinmutembei temporarily deployed to phedit March 29, 2016 16:20 Inactive
@collinmutembei collinmutembei merged commit dbe1cf9 into master Mar 30, 2016
@@ -0,0 +1,10 @@
[report]
omit =
*virtualenv*

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Quality - Nitpick
Sample review comment.

@collinmutembei collinmutembei temporarily deployed to phedit September 11, 2017 15:57 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants