Filling out README
This commit is contained in:
parent
03a42fb14d
commit
9227d900a6
45
README.md
45
README.md
|
@ -1,18 +1,57 @@
|
||||||
# Joyce
|
# Joyce
|
||||||
_A Reader and Editor for Hypertext_
|
_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
|
virtualenv -p /usr/bin/python2.7 joyce_flask
|
||||||
|
|
||||||
brew install elasticsearch
|
|
||||||
|
|
||||||
source bin/activate
|
source bin/activate
|
||||||
|
```
|
||||||
|
|
||||||
|
Install the Python backend:
|
||||||
|
```
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
Install the Javascript frontend:
|
||||||
|
```
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
Setup the Elasticsearch indexes:
|
||||||
|
```
|
||||||
python setup.py
|
python setup.py
|
||||||
|
```
|
||||||
|
|
||||||
|
## Run Locally
|
||||||
|
|
||||||
|
Start Elasticsearch:
|
||||||
|
```
|
||||||
elasticsearch
|
elasticsearch
|
||||||
|
```
|
||||||
|
|
||||||
|
Start Webpack in watch mode:
|
||||||
|
```
|
||||||
|
npm run watch
|
||||||
|
```
|
||||||
|
|
||||||
|
Start Python application:
|
||||||
|
```
|
||||||
python application.py
|
python application.py
|
||||||
|
```
|
||||||
|
|
||||||
localhost:5000
|
You should now find Joyce running locally at:
|
||||||
|
```
|
||||||
|
localhost:5000
|
||||||
|
```
|
Loading…
Reference in New Issue