Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 105 lines (73 sloc) 2.608 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
28 $ pip install -r requirements/compiled.txt
29 ```
30
31 3. Set up a local MySQL database. The [MySQL Installation Documentation][mysql]
32 explains how to do this.
33
34 4. Configure your local settings by copying `flicks/settings/local.py-dist` to
35 `flicks/settings/local.py` and customizing the settings in it:
36
37 ```sh
38 $ cp settings/local.py-dist settings/local.py
39 ```
40
41 The file is commented to explain what each setting does and how to customize
42 them.
43
44 5. Initialize your database structure:
45
46 ```sh
47 $ python manage.py syncdb
48 $ python manage.py migrate
49 ```
50
51 6. Install translations from SVN into the `firefox-flicks/locale` directory:
52
53 ```sh
54 $ git svn clone https://svn.mozilla.org/projects/l10n-misc/trunk/firefoxflicks/locale/ locale
55 # or
56 $ svn checkout https://svn.mozilla.org/projects/l10n-misc/trunk/firefoxflicks/locale/ locale
57 ```
58
ca5bb9a @Osmose Add gettext installation to README.
Osmose authored
59 7. Install the GNU version of `gettext`. If you are on OSX, you can do this
60 using [Homebrew][]:
61
62 ```sh
63 $ brew install gettext
64 $ brew link gettext
65 ```
66
67 8. Compile the translations:
5b6b03a @Osmose Update README with setup instructions.
Osmose authored
68
69 ```sh
70 $ python manage.py compilemessages
71 ```
72
73 [git]: http://git-scm.com/
74 [python]: http://www.python.org/
75 [mysql]: http://dev.mysql.com/doc/refman/5.6/en/installing.html
ca5bb9a @Osmose Add gettext installation to README.
Osmose authored
76 [Homebrew]: http://mxcl.github.com/homebrew/
5b6b03a @Osmose Update README with setup instructions.
Osmose authored
77
78
79 Running the Development Server
80 ------------------------------
81 You can launch the development server like so:
82
83 ```sh
84 $ python manage.py runserver
85 ```
86
87
88 Waffle Flags
89 ------------
90 The following [waffle][] flags are in use:
91
92 * `winners_page` - Controls whether the winners page is available, as well as
93 displaying winner information on designated videos.
94
95 [waffle]: https://github.com/jsocol/django-waffle
678e6b0 @fwenzel Added commonware, used X-Frame-Options middleware.
fwenzel authored
96
97
c897a5c @fwenzel added a readme.
fwenzel authored
98 License
99 -------
100 This software is licensed under the [New BSD License][BSD]. For more
101 information, read the file ``LICENSE``.
102
103 [BSD]: http://creativecommons.org/licenses/BSD/
104
Something went wrong with that request. Please try again.