Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 110 lines (76 sloc) 2.664 kb
5b6b03a @Osmose Update README with setup instructions.
Osmose authored
1 Firefox Flicks
2 ==============
3 Firefox Flicks is a [playdoh][gh-playdoh]-based site that allows users to submit
4 vidoes and view other entries in the Firefox Flicks contest.
c897a5c @fwenzel added a readme.
fwenzel authored
5
5b6b03a @Osmose Update README with setup instructions.
Osmose authored
6 [gh-playdoh]: https://github.com/mozilla/playdoh
c897a5c @fwenzel added a readme.
fwenzel authored
7
8
5b6b03a @Osmose Update README with setup instructions.
Osmose authored
9 Setup
10 -----
11 These instructions assume you have [git][], [python][], and `pip` installed. If
12 you don't have `pip` installed, you can install it with `easy_install pip`.
c897a5c @fwenzel added a readme.
fwenzel authored
13
5b6b03a @Osmose Update README with setup instructions.
Osmose authored
14 1. Start by getting the source:
c897a5c @fwenzel added a readme.
fwenzel authored
15
5b6b03a @Osmose Update README with setup instructions.
Osmose authored
16 ```sh
17 $ git clone --recursive git://github.com/mozilla/firefox-flicks.git
18 $ cd firefox-flicks
19 ```
20
21 2. Create a virtualenv for Flicks. Skip the first step if you already have
22 `virtualenv` installed.
23
24 ```sh
25 $ pip install virtualenv
26 $ virtualenv venv
27 $ source venv/bin/activate
e4eb2dd @Osmose Specify PIL version and clarify compiled requirements in README.
Osmose authored
28 ```
29
30 3. Install the compiled requirements:
31
32 ```sh
5b6b03a @Osmose Update README with setup instructions.
Osmose authored
33 $ pip install -r requirements/compiled.txt
34 ```
35
e4eb2dd @Osmose Specify PIL version and clarify compiled requirements in README.
Osmose authored
36 4. Set up a local MySQL database. The [MySQL Installation Documentation][mysql]
5b6b03a @Osmose Update README with setup instructions.
Osmose authored
37 explains how to do this.
38
e4eb2dd @Osmose Specify PIL version and clarify compiled requirements in README.
Osmose authored
39 5. Configure your local settings by copying `flicks/settings/local.py-dist` to
5b6b03a @Osmose Update README with setup instructions.
Osmose authored
40 `flicks/settings/local.py` and customizing the settings in it:
41
42 ```sh
43 $ cp settings/local.py-dist settings/local.py
44 ```
45
46 The file is commented to explain what each setting does and how to customize
47 them.
48
e4eb2dd @Osmose Specify PIL version and clarify compiled requirements in README.
Osmose authored
49 6. Initialize your database structure:
5b6b03a @Osmose Update README with setup instructions.
Osmose authored
50
51 ```sh
52 $ python manage.py syncdb
53 $ python manage.py migrate
54 ```
55
e4eb2dd @Osmose Specify PIL version and clarify compiled requirements in README.
Osmose authored
56 7. Install translations from SVN into the `firefox-flicks/locale` directory:
5b6b03a @Osmose Update README with setup instructions.
Osmose authored
57
58 ```sh
59 $ git svn clone https://svn.mozilla.org/projects/l10n-misc/trunk/firefoxflicks/locale/ locale
60 # or
61 $ svn checkout https://svn.mozilla.org/projects/l10n-misc/trunk/firefoxflicks/locale/ locale
62 ```
63
e4eb2dd @Osmose Specify PIL version and clarify compiled requirements in README.
Osmose authored
64 8. Install the GNU version of `gettext`. If you are on OSX, you can do this
ca5bb9a @Osmose Add gettext installation to README.
Osmose authored
65 using [Homebrew][]:
66
67 ```sh
68 $ brew install gettext
69 $ brew link gettext
70 ```
71
e4eb2dd @Osmose Specify PIL version and clarify compiled requirements in README.
Osmose authored
72 9. Compile the translations:
5b6b03a @Osmose Update README with setup instructions.
Osmose authored
73
74 ```sh
75 $ python manage.py compilemessages
76 ```
77
78 [git]: http://git-scm.com/
79 [python]: http://www.python.org/
80 [mysql]: http://dev.mysql.com/doc/refman/5.6/en/installing.html
ca5bb9a @Osmose Add gettext installation to README.
Osmose authored
81 [Homebrew]: http://mxcl.github.com/homebrew/
5b6b03a @Osmose Update README with setup instructions.
Osmose authored
82
83
84 Running the Development Server
85 ------------------------------
86 You can launch the development server like so:
87
88 ```sh
89 $ python manage.py runserver
90 ```
91
92
93 Waffle Flags
94 ------------
95 The following [waffle][] flags are in use:
96
97 * `winners_page` - Controls whether the winners page is available, as well as
98 displaying winner information on designated videos.
99
100 [waffle]: https://github.com/jsocol/django-waffle
678e6b0 @fwenzel Added commonware, used X-Frame-Options middleware.
fwenzel authored
101
102
c897a5c @fwenzel added a readme.
fwenzel authored
103 License
104 -------
105 This software is licensed under the [New BSD License][BSD]. For more
106 information, read the file ``LICENSE``.
107
108 [BSD]: http://creativecommons.org/licenses/BSD/
109
Something went wrong with that request. Please try again.