X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=README;h=92724d1f1a1462857b8ca64aad893ef326c86600;hb=557959f0e08f90646409d70f0231186d7a612c34;hp=a956b99aa2a61bcd5df016ffac78ff220f799fd3;hpb=b743d1af89ac416e7905a2b86c1749530e5829c8;p=unfold.git diff --git a/README b/README index a956b99a..92724d1f 100644 --- a/README +++ b/README @@ -1,46 +1,186 @@ -The contents of this module: +his file documents the contents of this module -==================== 1st level subdirs +See the devel/ subdir for more devel-oriented doc. + +==================== 1 minute howto + +* REQUIREMENTS is to have python + django installed django +** should be straightforward +** see devel/django-install.txt in case of trouble + +* git clone git://git.onelab.eu/myslice-django.git +-- or -- +* git clone ssh://yourlogin@git.onelab.eu/git/myslice-django.git + +* edit myslice/settings.py and +** change DEVELOPER_ROOT if you didnt clone into ~/git/myslice-django +** change the location of your backend API (not yet supported) + +* edit myslice/config.py and enter the details of your manifold backend + +* init django +$ manage.py syncdb + +* gather static files +$ make static + +* run a local server: +$ manage.py runserver 0.0.0.0:8000 +-- or -- my advice: +$ devel/server-loop.sh +when you just need to hit ^C yourself when your static files need to be refreshed - see below + +* use it from your browser + +.......... NOTES on using the development server +. first off, running manage.py runserver is provided by django as a development convenience but SHOULD NOT be used in production +. second, when you do use it for developement purposes, please be aware that: +.. the recommended layout for the various files and pieces (py, html, js and css) qith django is really painful + we should use e.g. plugins/simplelist.py, plugins/templates/plugins.html, plugins/static/js/simplelist.js and plugins/static/css/simplelist.css +.. as that does not make sense IMHO, I've rewritten the tool for gathering these pieces in such a layout but from a completely flat codebase + I mean I want to be able to store all the files building a plugin in a single (git) directory + Of course it's a completely different matter once the service is packaged and installed, these files of course get properly separated. +.. as a result it is a little bit less convenient to use the development server + when you change the layout of your static and template files, you might need to re-run 'make static', so it is recommended to use + devel/server-loop.sh instead + + +==================== Status + +*** Authentication *** + +Although there still are a few hard-coded accounts in the system, you +will only be able to see some static views and won't be able to send +real queries if you use these, so you'd better use a real account (one +that your manifold backend knows about). + +For logging out: click on 'logged as *jean*', this shows a +confirmation page for logging out. this is intended to be temporary. + + +*** Features *** + +We have a basic model for asynchroneous queries (referring to manifold +queries) and for plugins (in the most general sense a plugin is just a +piece of the output that may be connected to a query) + +Right now the UI has a handful of demo views only; as of this writing +only the list of slices actually comes from the manifold backend in an +asynchroneous way. + +Also all the views are gathered in the trash/ locations for now, being +that they're only for assessment purposes. + +* dahsboard : has one async. query and 2 plugins that share that + query; the intent was to demo a different layout in both cases, + although the datatables one won't work yet at this point. + +* the 'Plugin' view demonstrates most of the available plugins. + +* slice view : only demonstrates how to use URLs to pass arguments along + +* scroll view : mostly it only illustrates that some pages can be made + public (no need to login) + +* tab view : a hand-made tab widget + +Not much effort has yet been put into coming up with a nice layout, +feel free to tweak that but it's probably still way too early for +this. + +==================== + +Third party tools shipped: + +* jquery +* datatables +* spin +* bootstrap + +I've tried to keep track of the version I picked and to have an easy upgrade path. + +==================== Contents: 1st level subdirs + +========== code from git * myslice: - this is the sjango project', where to look for - . settings - . urls - . common static files + this is the django 'project', where to look for + . settings.py + . urls.py + +* engine: + the code for building / rendering plugins / queries + +* plugins: + the actual code for plugins + +* auth: + a django 'app' that deals with authentication; see especially + auth.backend.MyCustomBackend + for how to use a separate authentication system, + as well as settings.py for how to enable it * insert_above: a third-party django app for adding on-the-fly mentions to css or js files that need to go in the header - much like our past drupal_set_html_head() -* auth: - a django 'app' that deals with authentication +* trash/ + rough/preliminary views in here - as the name suggests this is temporary + +* views/ + will receive actual views over time + currently has some global html templates as well -* slice: - a django app for dealing with slice views +* third-party/ + * third party stuff (bootstrapfs, jquery, datatables) + * + some global static files (css, js, images..) + see more about that below too * devel: - only for various notes and other utiliy scripts + no code in there, only various notes and other scripts useful for developers + +========== automatically generated * all-static: (generated, no need to source-control) - this is where 'manage.py collectstatic' will gather all your static contents if you run a local server + this is where 'make static' will gather all your static contents if you run a local server make has convenience targets to refresh this area - $ make clean-static $ make static -==================== conventions + $ make clean-static + +* myslice.sqlite3 + this is where django stores its own stuff, as per settings.py + +==================== conventions for templates * templates: we store this under templates/ within the corresponding app, e.g. auth/templates/login.html - for now this is only about html, but the engine can be used for rendering anything including json or whatever.. + for now this is mostly about html, but the engine can be used for rendering anything + including js(on) or whatever.. + +==================== conventions for static files * static files: we chose to have all static files (images, but also javascript and stylesheets) in the various proj or app where they belong, under a static/ subdir that has this structure: where-it-belongs/ - static/ img/ css/ js/ - the stuff I have so far is in myslice/ because it looks common to all apps.. +* filenames / locations + + you can run the following make targets to have a summary of where things are + + $ make list-html list-js list-css list-img + -- or -- + $ make list-all + + +* plugins + use a naming scheme as simple as possible + like e.g. + plugins/quickfilter/quickfilter.py + plugins/quickfilter/quickfilter.html + plugins/quickfilter/quickfilter.js + plugins/quickfilter/quickfilter.css