Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
housleyjk committed Aug 9, 2015
1 parent b0268bb commit 206ea49
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,14 @@ Development
### Prerequisites ###
* Python (2.7)
* pip
* `easy_install pip`
* virtualenv
* `pip install virtualenv`
* virtualenv (virtualenvwrapper is recommended)

### Setup ###

Set up a python virtual environment however you want. Here's a simple way to do that:

mkdir lexTerm && cd lexTerm
virtualenv --no-site-packages server
virtualenv --no-site-packages server
cd server
source bin/activate

Expand All @@ -29,7 +27,13 @@ Install all python dependencies in the virtual environment

pip install -r requirements.txt

Initialize the sqlite database
Copy settings template

cp lexTerm/local_settings.py.tmpl lexTerm/local_settings.py

Edit local_settings.py to configure your database and other settings

Initialize the database

./manage.py syncdb --all
./manage.py migrate --fake
Expand All @@ -42,7 +46,7 @@ API Documentation
-----------------

On a running server, navigate to /api to browse the API.
Further documentation will be forthcoming.
Further documentation will be forthcoming.

Production
----------
Expand Down
19 changes: 19 additions & 0 deletions lexTerm/local_settings.py.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql_psycopg2',
'NAME': 'lexterm',
'USER': 'username',
'PASSWORD': '',
'HOST': 'localhost',
'PORT': '5432',
'ATOMIC_REQUESTS': True,
}
}
DEBUG_APPS = ('django_extensions',)

ES_HOST = 'search.lexterm.elucitrans.com'
ES_PORT = 80




0 comments on commit 206ea49

Please sign in to comment.