Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 68 lines (44 sloc) 1.898 kb
c897a5c @fwenzel added a readme.
fwenzel authored
1 playdoh
2 =======
3
4 Mozilla's Playdoh is a web application template based on [Django][django].
5
6 Patches are welcome! Feel free to fork and contribute to this project on
7 [github][gh-playdoh].
8
9 [django]: http://www.djangoproject.com/
10 [gh-playdoh]: https://github.com/mozilla/playdoh
11
f1445ea @fwenzel Recursive clone to check out initially. To start project, fork and branc...
fwenzel authored
12
c897a5c @fwenzel added a readme.
fwenzel authored
13 Requirements
14 ------------
15 You need Python 2.6.
16
f1445ea @fwenzel Recursive clone to check out initially. To start project, fork and branc...
fwenzel authored
17 To check out playdoh, run:
5610113 @fwenzel Check out vendor library recursively when starting.
fwenzel authored
18
f1445ea @fwenzel Recursive clone to check out initially. To start project, fork and branc...
fwenzel authored
19 git clone --recursive git://github.com/mozilla/playdoh.git
20
21 This project is set up to use a vendor library, i.e. a subdirectory ``vendor``
22 that contains all pure Python libraries required by this project. The recursive
23 checkout will also clone these requirements.
c897a5c @fwenzel added a readme.
fwenzel authored
24
25 In addition, there are compiled libraries (such as Jinja2) that you will need
26 to build yourself, either by installing them from ``pypi`` or by using your
27 favorite package manager for your OS.
28
29 For development, you can run this in a [virtualenv environment][virtualenv]:
30
31 easy_install pip
32 pip install -r requirements/compiled.txt
33
3c81e3d @fwenzel Packaging in Zamboni.
fwenzel authored
34 For more information on vendor libraries, read [Packaging in Zamboni][packaging].
35
36 [packaging]: http://jbalogh.github.com/zamboni/topics/packages/
c897a5c @fwenzel added a readme.
fwenzel authored
37 [virtualenv]: http://pypi.python.org/pypi/virtualenv
38
f1445ea @fwenzel Recursive clone to check out initially. To start project, fork and branc...
fwenzel authored
39
40 Starting a project based on playdoh
41 -----------------------------------
42 The default branch of playdoh is ``base``. To start a new project, you fork
43 playdoh and start working on your app in ``master`` (branched from base). If
44 you start adding pieces that should go back into playdoh, you can apply the
45 patch to base and move it upstream.
46
47 Eventually you'll probably diverge enough that you'll want to delete the base
48 branch.
49
50
678e6b0 @fwenzel Added commonware, used X-Frame-Options middleware.
fwenzel authored
51 Features
52 --------
53 Quick and dirty feature list:
54
55 * Django
56 * SHA-512 passwords
57 * X-Frame-Options: DENY by default
58 * Celery support
59
60
c897a5c @fwenzel added a readme.
fwenzel authored
61 License
62 -------
63 This software is licensed under the [New BSD License][BSD]. For more
64 information, read the file ``LICENSE``.
65
66 [BSD]: http://creativecommons.org/licenses/BSD/
67
Something went wrong with that request. Please try again.