Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 84 lines (56 sloc) 2.707 kB
3cee356 @lmorchard README first draft
authored
1 =============
2 django-badger
3 =============
4
5 Badger is a family of Django apps intended to help introduce badges into your
6 project, to track and award achievements by your users. This can be used to
7 help encourage certain behaviors, recognize skills, or just generally
8 celebrate members of your community.
9
10 For more about the thinking behind this project, check out this essay:
11 `Why does Mozilla need a Badger? <http://decafbad.com/2010/07/badger-article/>`_
12
2e81c8a @lmorchard README edits
authored
13 The ``django-badger`` package is the core Badger app. It offers (or plans to
14 offer) the following:
3cee356 @lmorchard README first draft
authored
15
16 - Basic badges, managed by the site owner in code and via Django admin.
17 - Badge awards, triggered in response to signal-based events with code
18 collected in per-app ``badges.py`` modules.
19 - Meta-badges, for which an award is automatically issued when a complete set
20 of prerequisite badge awards have been collected.
21 - Progress tracking, for which an award is issued when a user metric reaches
22 100% of some goal, or in response to some other custom logic.
23 - Activity streams of badge awards.
24
25
26 Installation
27 ------------
28
b13f3b6 @lmorchard README update
authored
29 - TBD, see `badg.us <https://github.com/lmorchard/badg.us>`_ for an example
3cee356 @lmorchard README first draft
authored
30 site setup
31 - ``pip install git://github.com/lmorchard/django-badger.git#egg=django-badger``
32
33 Settings
34 --------
35
b13f3b6 @lmorchard README update
authored
36 - TBD, see `badg.us <https://github.com/lmorchard/badg.us>`_ for an example
3cee356 @lmorchard README first draft
authored
37 site setup
62584ec @lmorchard Quietly ignore BadgeAlreadyAwardedException on updating progress for …
authored
38 - TBD, see ``badger/tests/badger_example/badges.py`` for an example.
3cee356 @lmorchard README first draft
authored
39
40
b23e0df Changes for vanilla Django
Phoebe B authored
41 Templates
42 ---------
43
44 There are two sets of templates in the templates folder. The templates
45 found in ``badger_playdoh`` are intended for use with Playdoh sites, while
46 those found in ``badger_vanilla`` are meant for plain Django sites.
47
48 You'll need to make a copy of one of these folders into a directory named
49 ``templates/badger`` at the top level of your project. Then, you can customize
50 the templates as necessary for your site.
51
3cee356 @lmorchard README first draft
authored
52 Creating badges
53 ---------------
54
62584ec @lmorchard Quietly ignore BadgeAlreadyAwardedException on updating progress for …
authored
55 - TBD, see ``badger/tests/badger_example/badges.py`` for an example.
3cee356 @lmorchard README first draft
authored
56
57
58 Awarding badges
59 ---------------
60
62584ec @lmorchard Quietly ignore BadgeAlreadyAwardedException on updating progress for …
authored
61 - TBD, see ``badger/tests/badger_example/badges.py`` for an example.
3cee356 @lmorchard README first draft
authored
62
63
4fc41e9 @lmorchard Add new award detail view
authored
64 Testing
65 -------
66
b13f3b6 @lmorchard README update
authored
67 - TBD, see `badg.us <https://github.com/lmorchard/badg.us>`_ for an example
4fc41e9 @lmorchard Add new award detail view
authored
68 site setup
69
70
3cee356 @lmorchard README first draft
authored
71 Other Badger apps
72 -----------------
73
74 Here are other apps in the Badger family, either in progress or proposed:
75
76 `django-badger-multiplayer <https://github.com/lmorchard/django-badger-multiplayer>`_
77 Badges for and by everyone. Augments ``django-badger`` with features to
78 make badge creation, nomination, and awarding a multiplayer game.
79
f069849 @lmorchard Update README.rst
authored
80 If you want to federate or share badges, you should check out
81 the `Mozilla Open Badges <https://github.com/mozilla/openbadges>`_ project.
3cee356 @lmorchard README first draft
authored
82
83 .. vim:set tw=78 ai fo+=n fo-=l ft=rst:
Something went wrong with that request. Please try again.