|
1 |
| -To install: |
| 1 | +# Flink |
2 | 2 |
|
3 |
| - # On some systems, easy_install might be easy_install.py |
4 |
| - $ sudo easy_install fabric |
5 |
| - # If asked about facebook-sdk, say wipe(w) to proceed |
6 |
| - $ fab setup |
| 3 | +This is intended to be deployed on a *nix system. |
| 4 | + |
| 5 | +All commands starting with 'fab' use python fabric and run the method |
| 6 | +('setup', 'deploy', etc.) that is in fabfile.py. You will need an internet |
| 7 | +connection to install the app's dependencies. |
| 8 | + |
| 9 | +## Dependencies |
| 10 | +Installing dependencies for your system varies by package manager. Yum, Apt, |
| 11 | +Pacman, etc. are a few you can use. Some of the more important dependencies that |
| 12 | +need to be installed on your *nix system: |
7 | 13 |
|
8 |
| -Dependencies that need to be installed: |
| 14 | + * python 2.7+ |
| 15 | + * not django (the app will take care of installing a specific version of |
| 16 | + django on your system: 1.3rc1) |
| 17 | + * Firefox 3.6+. |
| 18 | + * python-dev (aka python-devel in some repos) |
9 | 19 | * ffmpeg
|
10 | 20 | This might require the use of 3rd party repos. Fedora, for example, will
|
11 | 21 | only have packages in the official repo that are completely open source.
|
12 | 22 | The RPM Fusion repository comes in useful here. Ubuntu makes this easier.
|
13 | 23 | * libvorbis
|
14 | 24 | * libtheora
|
| 25 | + |
| 26 | + Video conversion will not be handled correctly if ffmpeg, libvorbis and |
| 27 | + libtheora aren't installed. |
| 28 | + |
| 29 | +## Install |
| 30 | + |
| 31 | + # On some systems, easy_install might be easy_install.py |
| 32 | + $ sudo easy_install fabric |
| 33 | + |
| 34 | + # If asked about facebook-sdk, say wipe(w) to proceed |
| 35 | + # If prompted to create a superuser, it is not necessary. |
| 36 | + $ fab setup |
| 37 | + |
| 38 | +## Deploy |
15 | 39 |
|
16 |
| -To deploy: |
17 | 40 | $ fab deploy
|
18 | 41 |
|
19 |
| -Then go to http://localhost:8000, or whatever server it started, in your |
20 |
| -browser. |
| 42 | +Then go to http://localhost:8000, or whatever server it started, in your browser. |
21 | 43 | Not a bug: when you signup, the app tries to send a confirmation email.
|
22 |
| -if your laptop isnt running a mailserver, it will fail, but just ignore it: |
23 |
| -Your account has been successfully created |
| 44 | +If your laptop isnt running a mailserver, it will fail, but just ignore it: |
| 45 | +Your account has been successfully created. |
24 | 46 |
|
25 |
| -Testing: |
| 47 | +There is test media (such as pictures, audio and video) in the test-media directory |
| 48 | +that you can use to upload to the app. |
| 49 | + |
| 50 | +## Testing |
26 | 51 |
|
27 | 52 | To load the test data:
|
| 53 | + |
28 | 54 | $ python manage.py loaddata app/fixtures/test_fixture.json
|
| 55 | + |
29 | 56 | Unit tests will load the test data on its own, but you can load the test data to probe the database.
|
30 | 57 |
|
31 | 58 | To just run the unit tests + selenium test:
|
| 59 | + |
32 | 60 | $ fab test
|
33 | 61 |
|
34 | 62 | To get the coverage report for the unit test only:
|
| 63 | + |
35 | 64 | $ coverage run --source=app/lib.py,app/views.py,app/decorators.py,urls.py ./manage.py test app.PeopleHandlerTest app.ProfileHandlerTest app.PosterboardHandlerTest app.ElementHandlerTest
|
36 |
| - $ coverage report |
| 65 | + $ coverage report |
| 66 | + |
| 67 | +## TODO |
| 68 | + |
| 69 | +See TODO.txt. There are a bunch of features needed to be implemented in there. |
0 commit comments