diff --git a/INSTALL.txt b/INSTALL.txt index 0788982..06d1346 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -9,11 +9,12 @@ python3-hunspell:0.5.5-2build6 uwsgi-core:2.0.20-4 uwsgi-plugin-python3:2.0.20-4 apache2:2.4.52-1ubuntu4.2 +python3-requests:2.25.1+dfsg-2 Installation ====== -This software expects to be installed at /opt/kjv-api/ +This software expects to be installed at /opt/kjv-api/ (for uwsgi use on a reverse proxy) This installation method is intended to play nice among other Virtual Hosts 0. Install dependancies listed at the head of this document. @@ -43,4 +44,4 @@ This installation method is intended to play nice among other Virtual Hosts - It is up to you to use https or not, but if you know nginx or haproxy you should be able to set up local proxying to the WSGI server that runs the flask. - There are WSGI modules for apache avaliable, which may be better for larger scaled - deployments, but http proxying to the local uwsgi served flask works fine. + deployments, but http proxying to the local uwsgi served flask works fine for smaller uses. diff --git a/README.txt b/README.txt index 128573a..94edee0 100644 --- a/README.txt +++ b/README.txt @@ -41,32 +41,37 @@ CONTENTS │   ├── kjv.aff - KJV Spellchecking Description file (hunspell) │   ├── kjv.db - KJV sqlite3 database │   └── kjv.dic - KJV Spellchecking dictionary file (hunspell) +│   └── seq.db - Sqlite3 Database with user's ids for sequenced scripture +│   └── shortcodes.db - Sqlite3 Database with saved shortcodes for scripture groups. ├── favicon.ico ├── html │   ├── dictionary.html - dictionary search landing page /define │   ├── find.html - unified search bar landing page /find -│   ├── header.html - navigation bar added programatically to rich results +│   ├── navbar.html - navigation bar added programatically to rich results │   ├── heaven.html - Bible way to heaven, static page /salvation +│   ├── on_reading_bible.html - Introduction on good reading practices │   ├── index.html - / landing page with unified search bar │   ├── reader.html - not yet implemented Bible browser end point │   ├── reading_plan.html - not yet implemented Bible reading plan generator │   ├── response.html - Template for rich verse responses │   ├── search.html - Bible keyword search landing page /search +│   ├── search_bar.html - Unused │   ├── show.html - Bible verse search landing page /show +│   ├── seq.html - Bible sequential verse landing page /seq │   └── votd.html - Matty's test VOTD rich landing page ├── install │   ├── apache.site.conf.example - example installation configuration │   └── kjv-api.service - example systemd service file ├── INSTALL.txt - installation instructions +├── logs - log folder (populated at runtime - there is NO log rotation) ├── js │   └── collapsible.js - js for the definition drop-down menu used in unified search -├── kjv-api.sh - runs flask app on port 1611 -├── kjv-api-test.sh - runs flask app on port 1612 -├── media -│   └── kjv_background.jpg - Matty's test rich media +├── kjv-api.sh - runs uwsgi flask app on port 1611 +├── kjv-api-test.sh - runs uwsgi flask app on port 1612 ├── README.txt - This document ├── styles │   ├── collapsible.css +│   ├── header.css │   ├── fonts │   │   ├── Arizonia-Regular.ttf │   │   └── Parisienne-Regular.ttf @@ -75,6 +80,9 @@ CONTENTS │   └── votd.css └── tools └── av1611_dictionary_scraper.py - builds a dictionary json for the 1828 dictionary + └── sanity_check.py - Integrated during runtime and also as endpoint testing when run alone. + └── search_keywords.txt - endpoint testing queries + └── sanity_results.txt - results of running sanity_check.py as a standalone AUTHOR ====== diff --git a/data/seq.db b/data/seq.db new file mode 100644 index 0000000..aaa187e Binary files /dev/null and b/data/seq.db differ diff --git a/data/shortcodes.db b/data/shortcodes.db new file mode 100644 index 0000000..8092c1d Binary files /dev/null and b/data/shortcodes.db differ diff --git a/media/kjv_background.jpg b/media/kjv_background.jpg deleted file mode 100644 index 63958c8..0000000 Binary files a/media/kjv_background.jpg and /dev/null differ