Reference implementation of an application directory
JavaScript Python Shell
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
development
directory
mozilla
openwebapps_directory.egg-info
vendor
wsgi
.gitignore
README.md
setup.py

README.md

Open Web Apps Reference Directory

This is an example of how you might create an application directory for listing Open Web Applications. It's meant to be a simple implementation that may be suitable to build on, or may just be an example you can consider as you decide how to design your own system.

How The Application Is Setup

There are only a couple pieces:

  • The database models are in directory/model.py. This is a very simple database setup using SQLAlchemy, and works with SQLite, MySQL, or PostgreSQL.

  • The application logic is in directory/wsgiapp.py. This includes a very small framework-like system, and some methods for specific pages.

  • The base templates are in directory/simple-templates/. These create a very boring but functional directory. If you want to create your own style these are a good starting place. The templates all use Jinja2.

  • Fancier templates are in directory/templates/. These make our actual site.

  • Static files are in directory/{template_dir}/static/ -- they go with the look of the site. There's very little Javascript.

Dependencies and Libraries

The dependencies are all in the vendor/ directory. This directory has to be added to sys.path to run the application; you can do that with $PYTHONPATH or using virtualenv.

This code expects you to use Python 2.6. Python 2.7 should work fine, 2.5 probably won't work (just because it's not tested), and Python 3.x will not work.

Administration

There's no logins, and everything is very simple; there's no big admin system, roles, etc.

You can however do a little bit of maintenance. The "users" are listed in a htpasswd style file (you can create it with htpasswd). Any user in this file will be an administration. Then go to /.mozilla/login and you can login. Once logged in you can add /admin to an application to change the featured status, and to delete the application.

You can also edit the keywords, hiding some (if they are unwanted) or adding descriptions. Go to /admin/keywords for this form.

Management tasks

Some notes if you want to actually extend this code.

To set everything up nicely for development run:

  • Create a virtualenv environment at this root
  • Link vendor/add-path.pth.link to lib/python2.6/site-packages/add-path.pth
  • Install compiled libraries with pip install -r compiled-requirements.txt
  • Install new vendor libraries with pip install --install-option="--install-lib=HERE/vendor" PACKAGE