Filling out README

This commit is contained in:
Alex Hunt 2018-05-09 22:52:38 -04:00
parent 03a42fb14d
commit 9227d900a6
1 changed files with 42 additions and 3 deletions

View File

@ -1,18 +1,57 @@
# Joyce
_A Reader and Editor for Hypertext_
Joyce is a web app for reading and annotating texts. It was designed to power The Joyce Project, a website to help introduce James Joyce's Ulysses to new readers with the full-text and detailed annotations.
## Setup
This assumes you have Node, npm, pip and optionall virtualenv installed.
Install Elasticsearch:
```
brew install elasticsearch
```
Joyce requires Python 2.7:
```
virtualenv -p /usr/bin/python2.7 joyce_flask
brew install elasticsearch
source bin/activate
```
Install the Python backend:
```
pip install -r requirements.txt
```
Install the Javascript frontend:
```
npm install
```
Setup the Elasticsearch indexes:
```
python setup.py
```
## Run Locally
Start Elasticsearch:
```
elasticsearch
```
Start Webpack in watch mode:
```
npm run watch
```
Start Python application:
```
python application.py
```
localhost:5000
You should now find Joyce running locally at:
```
localhost:5000
```