-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
24 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,18 +12,41 @@ Development | |
* `pip install virtualenv` | ||
|
||
### 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 | ||
cd server | ||
source bin/activate | ||
|
||
Clone the source repository from GitHub: | ||
|
||
git clone [email protected]:LexTerm/LexTermServer.git lexTerm | ||
cd lexTerm | ||
|
||
Install all python dependencies in the virtual environment | ||
|
||
pip install -r requirements.txt | ||
|
||
Initialize the sqlite database | ||
|
||
./manage.py syncdb | ||
|
||
### Run it ### | ||
|
||
./manage.py runserver | ||
|
||
API Documentation | ||
----------------- | ||
|
||
API documentation can be found at http://docs.lexterm.apiary.io/ | ||
|
||
Apiary provides a mock server which can be used for development. Here's an example of using it with | ||
cURL: | ||
|
||
curl --include "http://lexterm.apiary.io/api" | ||
|
||
Production | ||
---------- | ||
|
||
|
@@ -40,3 +63,4 @@ Production | |
### Deploy ### | ||
* to update, simply `git pull` in the repository | ||
* make sure to run `./manage.py syncdb` if any changes were made to database schemas | ||
|