Commit dce289f8 authored by Ville Korhonen's avatar Ville Korhonen
Browse files

Converted GETTING-STARTED to README.md

parent 23165a7a
Debian NM Front Desk web application
====================================
* Running this code on your own machine
## Running this code on your own machine
### Dependencies
apt-get install python-django python-ldap python-psycopg2 python-xapian python-debian
# Dependencies
apt-get install python-django python-ldap python-psycopg2 python-xapian python-debian
### Configuration
# Configuration
mkdir data # required by default settings
ln -s settings.py.devel settings.py
edit settings.py as needed
mkdir data # required by default settings
ln -s settings.py.devel settings.py
edit settings.py as needed
# First setup
./manage.py syncdb
### First setup
./manage.py syncdb
# Fill in data
### Fill in data
Visit https://nm.debian.org/am/db-export to download nm-mock.json; for privacy,
sensitive information are replaced with mock strings.
......@@ -20,31 +24,31 @@ If you cannot login to the site, you can ask any DD to download it for you.
There is nothing secret in the file, but I am afraid of giving out convenient
email databases to anyone.
./manage.py import nm-mock.json
./manage.py import nm-mock.json
If you are a Front Desk member or a DAM, you can use
https://nm.debian.org/am/db-export?full for a full database export.
# Sync keyrings (if needed)
rsync -az --progress keyring.debian.org::keyrings/keyrings/ ./data/keyrings/
### Sync keyrings
rsync -az --progress keyring.debian.org::keyrings/keyrings/ ./data/keyrings/
# Run database maintenance
./manage.py maintenance
### Run database maintenance
./manage.py maintenance
# Run the web server
./manage.py runserver
### Run the web server
./manage.py runserver
* Periodic updates
## Periodic updates
You need to run periodic maintenance to check/regenerate the denormalised
fields:
./manage.py maintenance
./manage.py maintenance
* Development
## Development
Development targets Django 1.2, as it is the version available on Debian
servers. Luckily django provides excellent backwards compatibility, so the only
thing you have to pay attention to is the version of the Django documentation
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment