summaryrefslogtreecommitdiffstats
path: root/INSTALL
blob: 0b35f7f56e07af573349b093dbec8bc30b07d635 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
This is the INSTALL file for Brainch. This document provides convenient steps so a user/developer can have Brainch running quickly.

Brainch has been successfully tested on both GNU/Linux and Mac OS X Tiger 
Operating Systems.

### Dependencies

Please first install these software in order to get Brainch running properly:

  - Django <http://www.djangoproject.org/>
  - SQLite3 <http://www.sqlite.org/>
  - PySQLite2 <http://trac.edgewall.org/wiki/PySqlite>
  - Git <http://git-scm.com/>
  - Git-Python <http://gitorious.org/git-python>
  - google-diff-match-patch <http://code.google.com/p/google-diff-match-patch/>


### Installation

 1. Once you've installed the required dependencies:
        cd /path/to/brainch/mysite


 2. Build the database:
        python manage syncdb
    (The prompt will ask for the admin infos.)
    (Initial data will be loaded:) 
    (a "Brainch" group, and the "Free Art Licence 1.3") 

    
 3. Run the django webserver:
        python manage.py runserver


 4. Open a web browser and visit this URL:
        <http://localhost:8000/>
    
    
That's it!

You can manage the users, their repositories and the licences via the web admin interface at <http://localhost:8000/admin>.