https://github.com/oddbird/portfoliyo

A communication tool for teachers and parents
https://github.com/oddbird/portfoliyo

Last synced: 8 days ago
JSON representation

A communication tool for teachers and parents

• Host: GitHub
• URL: https://github.com/oddbird/portfoliyo
• Owner: oddbird
• Created: 2012-07-19T15:30:39.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2016-02-26T18:18:21.000Z (over 8 years ago)
• Last Synced: 2024-10-29T18:48:50.306Z (16 days ago)
• Language: Python
• Homepage: https://www.portfoliyo.org
• Size: 69.9 MB
• Stars: 11
• Watchers: 5
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
Portfoliyo

==========

Development

-----------

If you want to run this project in a `virtualenv`_ to isolate it from

other Python projects on your system, create a virtualenv and activate

it.  Then run ``bin/install-reqs`` to install the dependencies for this

project into your Python environment.

In order to run Portfoliyo (or its tests), you'll need a PostgreSQL

database. By default, Portfoliyo will look for a PostgreSQL database named

"portfoliyo" on localhost.

You may need to create a ``portfoliyo/settings/local.py`` file with some

details of your local configuration.  See

``portfoliyo/settings/local.sample.py`` for a sample that can be copied to

``portfoliyo/settings/local.py`` and modified.

Once this configuration is done, you should be able to run ``./manage.py

syncdb --migrate``, then ``./manage.py runserver`` and access the site

in your browser at ``http://localhost:8000``.

You can run the tests with ``py.test`` (or ``grunt pytest``), or the

``Selenium`` tests with ``py.test portfoliyo/tests/selenium``.

.. _virtualenv: http://www.virtualenv.org

.. _Selenium: http://seleniumhq.org

To install the necessary Ruby gems for Compass/Sass development (only

necessary if you plan to modify Sass files and re-generate CSS), install

Bundler (``gem install bundler``) and then run ``bundle install``.

Local development on this project requires `Node.js`_ >= 0.8.0 for JS linting

and handlebars template compilation. To install the necessary Node

dependencies, first ``npm install -g grunt-cli`` (once per system), then ``npm

install`` (whenever ``package.json`` changes).

You can lint the project's JS with ``grunt jshint``.

You can compile Handlebars templates in the ``jstemplates/`` directory to the

compiled-templates file (``static/js/jstemplates.js``) with ``grunt

handlebars``.

You can compile Sass to CSS with ``grunt compass``. This requires first

installing Bundler (``gem install bundler``) and then running ``bundle

install`` to get the necessary Ruby gems installed.

Just running ``grunt`` will perform all of the above tasks.

``grunt dev`` will watch for changes to local files and automatically perform

an appropriate selection of the above tasks whenever changes are detected

to relevant files.

Refer to the Gruntfile.js source and `Grunt`_ documentation for more info.

.. _Node.js: http://nodejs.org

.. _JSHint: http://www.jshint.com

.. _Grunt: http://gruntjs.com/

Deployment

----------

In addition to the above configuration, in any production deployment

this entire app should be served exclusively over HTTPS (since serving

authenticated pages over HTTP invites session hijacking

attacks). Ideally, the non-HTTP URLs should redirect to the HTTPS

version.

``portfoliyo/settings/prod.py`` should be used as the settings module in a

production deployment in place of ``portfoliyo/settings/default.py`` (set

``DJANGO_SETTINGS_MODULE=portfoliyo.settings.prod``). Site-specific overrides

can still be placed in ``portfoliyo/settings/local.py``.

You can run ``./manage.py checksecure`` to verify that settings are correctly

configured for a secure deployment.

This app also uses the `staticfiles contrib app`_ in Django for

collecting static assets from reusable components into a single

directory for production serving.  Under "runserver" in development this

is handled automatically.  In production, run ``./manage.py

collectstatic`` to collect all static assets into the

``collected-assets`` directory (or whatever ``STATIC_ROOT`` is set to in

``settings_local.py``), and make those collected assets available by

HTTP at the ``STATIC_URL`` setting.

.. _staticfiles contrib app: http://docs.djangoproject.com/en/1.4/howto/static-files/