1 This file documents the contents of this module
3 See the devel/ subdir for more devel-oriented doc.
5 ==================== 1 minute howto
7 * REQUIREMENTS is to have python + django installed django
8 ** should be straightforward
9 ** see devel/django-install.txt in case of trouble
11 * git clone git://git.onelab.eu/myslice-django.git
13 * git clone ssh://yourlogin@git.onelab.eu/git/myslice-django.git
15 * edit myslice/settings.py and
16 ** change DEVELOPER_ROOT if you didnt clone into ~/git/myslice-django
17 ** change the location of your backend API (not yet supported)
22 [ at this point point it *might* be needed to run
24 but as far as running a local server is concerned you should be good without that
25 feedback on this is appreciated]
28 $ manage.py runserver 0.0.0.0:8000
30 * use it from your browser
33 ==================== Status
35 For now there's not much in here;
37 * Logging in should be easy using one of the few hard coded accounts
38 this was the simplest possible way to demonstrate deferring authorization elsewhere
39 * To logout, click on 'logged as *jean*', this shows a confirmation page..
42 Right now the UI has 4 views:
44 * the most useful one being the 'Plugin' view which demonstrates all the available plugins
45 see test_plugin_view in engine/views.py
47 * slice view : only demonstrates how to use URLs to pass arguments along
48 * scroll view : forget about that one, but it does illustrate that some pages can be made public (no need to login)
49 * tab view : a hand-made tab widget
50 (last three from slice/views.py)
53 Third party tools shipped:
59 not much effort has been put into coming up with a nice layout and all, feel free to tweak that but it's probably way too early for that
61 ==================== Contents: 1st level subdirs
63 ========== code from git
65 this is the django 'project', where to look for
70 the code for building / rendering plugins
73 the actual code for plugins
76 a django 'app' that deals with authentication; see especially
77 auth.backend.MyCustomBackend
78 for how to use a separate authentication system,
79 as well as settings.py for how to enable it
82 a django app for dealing with slice views
85 a third-party django app for adding on-the-fly mentions to css or js files that need to go in the header
90 * templates (django templates, i.e. (essentially html) fragments that can be specializied)
91 * static files (css, js, images..)
92 see more about that below
95 no code in there, only various notes and other scripts useful for developers
97 ========== automatically generated
99 * all-static: (generated, no need to source-control)
100 this is where 'manage.py collectstatic' will gather all your static contents if you run a local server
101 make has convenience targets to refresh this area
106 this is where django stores its own stuff, as per settings.py
109 ==================== conventions for templates and static
112 we store this under templates/ within the corresponding app, e.g.
113 auth/templates/login.html
114 for now this is mostly about html, but the engine can be used for rendering anything including js(on) or whatever..
117 we chose to have all static files (images, but also javascript and stylesheets) in the various
118 proj or app where they belong, under a static/ subdir that has this structure:
126 NOTE. in essence any of these files can be moved around (from e.g. one templates/ dir to another)
127 at any time without any change needed in the code