satchlj
/
joyce
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Adding to README

This commit is contained in:
Alex Hunt 2018-05-09 23:00:44 -04:00
parent 9227d900a6
commit 667c4548a2
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -1,7 +1,9 @@
# 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.
Joyce is a web app for reading and annotating texts. It was designed to power [The Joyce Project](http://www.joyceproject.com/), a website to help introduce James Joyce's Ulysses to new readers with the full-text and detailed annotations.
Joyce uses Python and Flask for the backend, Elasticsearch for the datastore, and React and Bootstrap for the front end, bundled with Webpack. The text editor is built on DraftJS.
## Setup

2
TODO.txt
View File

@ -1,8 +1,6 @@
REFACTORING CHECKLIST:
- Switch to Webpack Dev Server and Remove Webpack-Flask Dependencies
- Write ReadMe
- One Pass Through Every Module's Imports
- Rename Components
NEED:
- Deploy Process