Skip to content

Commit

Permalink
updating README
Browse files Browse the repository at this point in the history
updating READM
  • Loading branch information
paveu committed Jun 3, 2016
1 parent 3a9548d commit c855510
Showing 1 changed file with 15 additions and 47 deletions.
62 changes: 15 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,27 +30,6 @@ content-publisher is a project for selling out video content. All videos we sell
- posibility to host project source code on heroku with static and media files on AWS S3 bucket
- django-debug-toolbar implemented


### Todos
- add Flower for monitor Celery tasks
- fixing comment thread with angular.js - top priority
- add fabric deployment script with filling in site id=1 for facebook socialapp
- add celery for getting exchange rate from usd->pln. do it periodicaly and save a result to database
- add Sentry for monitoring exepctions happen within the project
- improving user account panel with angular.js
- deploying project with fabric script for local/stage and production
- braintree and payu tutorials for those who wants to run it in production mode
- add tox, coverage, pytest
- covering all models along with payment systems with unit and functional tests
- exposing transaction model with REST API only for thoe users who has permision
- add automatic resize and compress images with PIL

### Todos: Status bars
- https://requires.io/plans/
- https://coveralls.io
- https://docs.travis-ci.com/user/status-images/
- http://shields.io/ (reelase image)

### Local deployment tutorial

[---> Link <---](https://github.com/paveu/content-publisher/blob/master/docs/deployment_to_local.md)
Expand All @@ -63,36 +42,25 @@ content-publisher is a project for selling out video content. All videos we sell

[---> Link <---](https://github.com/paveu/content-publisher/blob/master/docs/deployment_to_aws_elastic_beanstalk.md)



### External libraries used in the project
content-publisher uses a number of open source projects to work properly:

* [braintree] - Payment system, ver: 3.25.0
* [colorama] - Cross-platform colored terminal text, ver: 0.3.7
* [Django] - The Web framework for perfectionists with deadlines, ver: 1.9.5
* [django-allauth] - Integrated set of Django applications addressing authentication, registration, account management as well as 3rd party (social) account authentication, ver: 0.25.2
* [django-debug-toolbar] - The Django Debug Toolbar is a configurable set of panels that display various debug information about the current request/response and when clicked, display more details about the panel's content, ver: 1.4
* [django-ipware] - Best attempt to get user's (client's) real ip-address while keeping it DRY, ver: 1.1.5
* [django-cors-headers] - A Django App that adds CORS (Cross-Origin Resource Sharing) headers to responses, ver: 1.1.0
* [django-crispy-forms] - Better formatted form template, ver: 1.6.0
* [django-filter] - Django-filter provides a simple way to filter down a queryset based on parameters a user provides, ver: 0.13.0
* [djangorestframework] - Django REST framework is a powerful and flexible toolkit for building Web APIs, ver: 3.3.3
* [djangorestframework-jwt] - JSON Web Token Authentication support for Django REST Framework, ver: 1.8.0
* [httpie] - HTTPie (pronounced aitch-tee-tee-pie) is a command line HTTP client, ver: 0.9.3
* [Markdown] - Python implementation of Markdown, ver: 2.6.6
* [Pillow] - Python Imaging Library, ver: 3.2.0
* [Pygments] - Python syntax highlighter, ver: 2.0.2
* [PyJWT] - A Python implementation of RFC 7519. Original implementation was written by @progrium, ver: 1.4.0
* [requests] - Requests is the only Non-GMO HTTP library for Python, safe for human consumption, ver: 2.9.1
* [Bootstrap] - is the most popular HTML, CSS, and JS framework for developing responsive, mobile first projects on the web, ver: 3.1.1
* [jQuery] - is a fast, small, and feature-rich JavaScript library. It makes things like HTML document traversal and manipulation, event handling, animation, and Ajax much simpler with an easy-to-use API that works across a multitude of browsers ver: 1.11.0

### Version
* version: 1.3
* version: 1.4.0
* project started in 08/may/2015.
* code taken from my old repo: [https://github.com/paveu/srvup](https://github.com/paveu/srvup)

### Todos
- add Flower for monitor Celery tasks
- fixing comment thread with angular.js - top priority
- add fabric deployment script with filling in site id=1 for facebook socialapp
- add celery for getting exchange rate from usd->pln. do it periodicaly and save a result to database
- add Sentry for monitoring exepctions happen within the project
- improving user account panel with angular.js
- deploying project with fabric script for local/stage and production
- braintree and payu tutorials for those who wants to run it in production mode
- add tox, coverage, pytest
- covering all models along with payment systems with unit and functional tests
- exposing transaction model with REST API only for thoe users who has permision
- add automatic resize and compress images with PIL

License
----

Expand Down

0 comments on commit c855510

Please sign in to comment.