README 1.55 KB
Newer Older
Ángel Velásquez's avatar
Ángel Velásquez committed
1
2
3
4
5
6
# Archweb README

To get a pretty version of this document, run

    $ markdown README > README.html

eliott's avatar
eliott committed
7
# License
Ángel Velásquez's avatar
Ángel Velásquez committed
8
9

See LICENSE file.
eliott's avatar
eliott committed
10
11

# Authors
Ángel Velásquez's avatar
Ángel Velásquez committed
12
13

See AUTHORS file.
eliott's avatar
eliott committed
14

eliott's avatar
eliott committed
15
# Dependencies
eliott's avatar
eliott committed
16

Ángel Velásquez's avatar
Ángel Velásquez committed
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
- python
- python-virtualenv

# Python dependencies

More detail in `requirements.txt` and `requirements_prod.txt`; it is best to
use virtualenv to handle these. But if you insist on (Arch Linux) packages, you
will probably want the following:

- mysql-python or python-pysqlite
- django
- python-markdown
- python-south
- python-memcached

# Testing Installation

1. Run `virtualenv`.

        $ cd /path/to/archweb && virtualenv ../archweb
eliott's avatar
eliott committed
37

Ángel Velásquez's avatar
Ángel Velásquez committed
38
2. Install dependencies through `pip`.
eliott's avatar
eliott committed
39

Ángel Velásquez's avatar
Ángel Velásquez committed
40
        $ pip -r requirements.txt
eliott's avatar
eliott committed
41

Ángel Velásquez's avatar
Ángel Velásquez committed
42
43
44
45
46
47
48
49
50
51
52
53
54
55
3. Copy `local_settings.py.example` to `local_settings.py` and modify.
   Make sure to uncomment the appropriate db section (either sqlite or mysql).

4. Sync the database to create it.

        $ python manage.py syncdb

5. Migrate changes.

        $ python manage.py migrate

6. Load the fixtures to prepopulate some data.

        $ python manage.py loaddata main/fixtures/arches.json main/fixtures/repos.json
eliott's avatar
eliott committed
56
    
Ángel Velásquez's avatar
Ángel Velásquez committed
57
58
59
60
61
62
63
64
65
66
7. Use the following commands to start a service instance

        $ python manage.py runserver

8. To optionally populate the database with real data:

        $ wget ftp://ftp.archlinux.org/core/os/i686/core.db.tar.gz
        $ ./manage.py reporead i686 core.db.tar.gz

Alter architecture and repo to get x86\_64 and packages from other repos if needed.
eliott's avatar
eliott committed
67

Ángel Velásquez's avatar
Ángel Velásquez committed
68
# Production Installation
Dusty Phillips's avatar
Dusty Phillips committed
69

Ángel Velásquez's avatar
Ángel Velásquez committed
70
Ask someone who knows, or you are going to be in trouble.
Dusty Phillips's avatar
Dusty Phillips committed
71

Ángel Velásquez's avatar
Ángel Velásquez committed
72
vim: set syntax=markdown et: