Name: skifftasks
Owner: skiffhack
Description: null
Created: 2012-01-14 13:07:07.0
Updated: 2013-01-06 01:49:17.0
Pushed: 2012-01-14 20:48:30.0
Homepage: http://dharmafly.com/tasket
Size: 435
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
Tasket Boilerplate is a simple, wrapped version of Tasket, the open-source micro-task web app. The boilerplate has the Tasket core repository installed as a Git submodule. This allows you to: fork the Tasket Boilerplate repo, add your own custom HTML, JavaScript, CSS, or images for your project and still keep the core Tasket submodule up-to-date.
The submodule will need to be activated the first time you checkout the repository:
git submodule init
git submodule update
This will checkout the latest version of Tasket but the repository itself will not be set to a particular branch. This is fine for running the application but if you intend to develop Tasket within the submodule you'll want to set a branch.
cd tasket
git checkout master
cd ../
Tasket has a few dependencies (see Tasket README for details). It's recommended to run Tasket in a virtualenv with pip:
virtualenv --no-site-packages .
source bin/activate
Then install Tasket's requirements. Issuing the following from within a virtualenv will set up all the 3rd party packages needed for Tasket to run:
pip install -r tasket/requirements.txt
The /client/media folder contains a folder called custom, which is for any of the target website's own static assets.
Tasket's own static assets should already be present (as symlinks from /tasket/client/media) - e.g. in the /client/media/lib and /client/media/tank folders. If not, then they should be manually symlinked into the target client:
cd client/media
# core libraries
ln -s ../../tasket/client/media/lib .
# specific apps (omit those not required)
ln -s ../../tasket/client/media/tank .
ln -s ../../tasket/client/media/notepad .
# back to the root
cd ../../
1) It may be sufficient to symlink the /web folder of Tasket into the root folder:
ln -s tasket/web .
OR…
2) On some platforms, Django's web server will not respond to a symlinked web folder. You may see the app running with the default Tasket theme, not the extended custom theme. In such a case, the folder should be copied into the root folder:
# first delete the symlinked /web folder, then:
cp -rf tasket/web .
Then amend the /web/settings.py file to point to the appropriate server folder. Change this:
sys.path.append('../server')
to this:
sys.path.append('../tasket/server')
Any install-specific changes should be made in local_settings.py, following the example settings in local_settings.py.example:
cd web
cp local_settings.py.example local_settings.py
As with a plain Tasket installation:
python manage.py syncdb
then proceed to set up a superuser, then:
python manage.py migrate
Make sure that virtualenv has been activated from the root folder:
source bin/activate
Run the server:
cd web
python manage.py runserver
The client-side app requires the compressed versions of the Tasket JavaScript to have been compiled. To do this ensure you have the most recent version of Tasket in the submodule:
cd tasket
git pull
Then run Smoosh in the root directory. You'll need smoosh installed on your path.
Check the Tasket README for more details.
cd ../
smoosh -c ./config.json
NOTE: this is a different config.json file than that in the Tasket directory.
If the JavaScript or CSS has updated, then update the query-string version numbers in the HTML file, e.g. in /client/tank.html :
<script src="/media/tasket/js/tasket.min.js?v0.8"></script>
If the files have changed, be sure to commit them into to the repository:
git add .
git commit -m "Merging Tasket changes"
git push