X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=README;h=92724d1f1a1462857b8ca64aad893ef326c86600;hb=2f570c9fab30a41767b20607bb3e01d102f12fec;hp=7aa08fcd43755ee679beacbffb0b1a99168edcac;hpb=b819c832cd3efe0a37966196430bcf3ec0aaf0cb;p=myslice.git diff --git a/README b/README index 7aa08fcd..92724d1f 100644 --- a/README +++ b/README @@ -1,4 +1,4 @@ -This file documents the contents of this module +his file documents the contents of this module See the devel/ subdir for more devel-oriented doc. @@ -16,47 +16,88 @@ See the devel/ subdir for more devel-oriented doc. ** 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 -[ at this point point it *might* be needed to run -$ make allst - but as far as running a local server is concerned you should be good without that - feedback on this is appreciated] +* 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 -For now there's not much in here; +*** 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 *** -* Logging in should be easy using one of the few hard coded accounts - this was the simplest possible way to demonstrate deferring authorization elsewhere -* To logout, click on 'logged as *jean*', this shows a confirmation page.. +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. -Right now the UI has 4 views: +Also all the views are gathered in the trash/ locations for now, being +that they're only for assessment purposes. -* the most useful one being the 'Plugin' view which demonstrates all the available plugins - see test_plugin_view in engine/views.py +* 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 : forget about that one, but it does illustrate that some pages can be made public (no need to login) + +* scroll view : mostly it only illustrates that some pages can be made + public (no need to login) + * tab view : a hand-made tab widget -(last three from slice/views.py) +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 -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 +I've tried to keep track of the version I picked and to have an easy upgrade path. ==================== Contents: 1st level subdirs @@ -67,7 +108,7 @@ not much effort has been put into coming up with a nice layout and all, feel fre . urls.py * engine: - the code for building / rendering plugins + the code for building / rendering plugins / queries * plugins: the actual code for plugins @@ -78,18 +119,20 @@ not much effort has been put into coming up with a nice layout and all, feel fre for how to use a separate authentication system, as well as settings.py for how to enable it -* slice: - a django app for dealing with slice views - * 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 -* templates/ -* static/ - some global stuff: - * templates (django templates, i.e. (essentially html) fragments that can be specializied) - * static files (css, js, images..) - see more about that below +* 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 + +* third-party/ + * third party stuff (bootstrapfs, jquery, datatables) + * + some global static files (css, js, images..) + see more about that below too * devel: no code in there, only various notes and other scripts useful for developers @@ -97,32 +140,47 @@ not much effort has been put into coming up with a nice layout and all, feel fre ========== 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 + $ make clean-static * myslice.sqlite3 this is where django stores its own stuff, as per settings.py - -==================== conventions for templates and static +==================== conventions for templates * templates: we store this under templates/ within the corresponding app, e.g. auth/templates/login.html - for now this is mostly about html, but the engine can be used for rendering anything including js(on) 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/ +* 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 -NOTE. in essence any of these files can be moved around (from e.g. one templates/ dir to another) -at any time without any change needed in the code