Adding to README
This commit is contained in:
parent
9227d900a6
commit
667c4548a2
|
@ -1,7 +1,9 @@
|
||||||
# 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.
|
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
|
## Setup
|
||||||
|
|
||||||
|
|
2
TODO.txt
2
TODO.txt
|
@ -1,8 +1,6 @@
|
||||||
REFACTORING CHECKLIST:
|
REFACTORING CHECKLIST:
|
||||||
- Switch to Webpack Dev Server and Remove Webpack-Flask Dependencies
|
- Switch to Webpack Dev Server and Remove Webpack-Flask Dependencies
|
||||||
- Write ReadMe
|
|
||||||
- One Pass Through Every Module's Imports
|
- One Pass Through Every Module's Imports
|
||||||
- Rename Components
|
|
||||||
|
|
||||||
NEED:
|
NEED:
|
||||||
- Deploy Process
|
- Deploy Process
|
||||||
|
|
Loading…
Reference in New Issue