Update wiki links to the new short URL
[aur.git] / TESTING
blob972bce2cae212c444c2dff52fce0bd915641926a
1 Setup Testing Environment
2 =========================
4 Note that this setup is only to test the web interface. If you need to have a
5 full aurweb instance with cgit, ssh interface, etc, follow the directions in
6 INSTALL.
8 1) Clone the aurweb project:
10     $ git clone git://git.archlinux.org/aurweb.git
12 2) Install the necessary packages:
14     # pacman -S --needed php php-sqlite sqlite words fortune-mod \
15                          python python-sqlalchemy python-alembic \
16                          python-fastapi uvicorn nginx \
17                          python-authlib python-itsdangerous python-httpx \
18                          words fortune-mod
20    Ensure to enable the pdo_sqlite extension in php.ini.
22 3) Copy conf/config.dev to conf/config and replace YOUR_AUR_ROOT by the absolute
23    path to the root of your aurweb clone. sed can do both tasks for you:
25     $ sed -e "s;YOUR_AUR_ROOT;$PWD;g" conf/config.dev > conf/config
27    Note that when the upstream config.dev is updated, you should compare it to
28    your conf/config, or regenerate your configuration with the command above.
30 4) Prepare the testing database:
32     $ cd /path/to/aurweb/
34     $ AUR_CONFIG=conf/config python -m aurweb.initdb
36     $ schema/gendummydata.py data.sql
37     $ sqlite3 aurweb.sqlite3 < data.sql
39 5) Run the test server:
41    $ AUR_CONFIG=conf/config python -m aurweb.spawn