File	Date	Author	Commit
backend	2017-01-22	INKE Dev User	[4c2311] added example DatabaseCredentials for reference
borrowed	2015-08-02	INKE Dev User	[4d07da] added Amy to Team; added Sonnets to Poetry adapter
frontend	2016-02-22	INKE Dev User	[339469] fixed Collection bug looking for edges
installation	2017-01-21	INKE Dev User	[548c37] updated doc
.gitignore	2014-04-10	INKE Dev User	[0e870e] major fixes to pagination
.htaccess	2013-03-01	Jake Bruce	[2ec86d] Upgraded to new version of xml parser
LICENSE.txt	2013-02-22	Jake Bruce	[c888f4] Initial commit.
README	2015-05-05	INKE Dev User	[85d293] documentation tweaks
down.png	2014-08-20	INKE Dev User	[0adaf6] Data export functionality
error.gif	2013-02-22	Jake Bruce	[91a488] Populating repository with commit of first brok...
favicon.ico	2013-02-22	Jake Bruce	[91a488] Populating repository with commit of first brok...
index.html	2015-08-15	INKE Dev User	[e6d871] Collection-only Edges mostly implemented
loading-spinner.gif	2013-02-22	Jake Bruce	[91a488] Populating repository with commit of first brok...
main.css	2015-06-27	INKE Dev User	[052624] initial work for colour schemes
multiple-import.html	2015-05-26	INKE Dev User	[9e60bd] bookmark uri-encoding; paste option for multi-i...
multiple-import.png	2015-05-20	INKE Dev User	[2d0269] added image capability to ImportMultipleNodesAd...
small-spinner.gif	2013-02-22	Jake Bruce	[91a488] Populating repository with commit of first brok...
up.png	2014-05-21	INKE Dev User	[8fe2d7] added arrow images and NewRadial team profile p...

Read Me

INSTALLATION

NewRadial depends on 3 things:

	* A web server
	* NodeJS
	* A Postgresql database

Install and configure those first.

Clone the NewRadial repo into a web-visible directory (this depends on your
operating system and your server software of choice).

NewRadial contains a script at backend/db_scripts/ddl.script that you can use
to construct the initial tables and sequences in the database required for
NewRadial.

NewRadial also contains scripts at
backend/start-node-server.sh, backend/stop-node-server.sh, and
backend/restart-node-server.sh that start, stop, and restart (stop and start)
the NodeJS server instance running NewRadial.  Check these scripts to make sure
paths and environment variables are correct for your set-up.

EDITING

Any time a JavaScript file is changed in the backend/ directory, the NodeJS
server must be restarted for the changes to take effect.  This is not required
for changes in frontend/, where a simple browser refresh will load the changes.

Using commands in the Logger module (debug, log, err) outputs messages from
backend scripts to the file backend/logs/today.log .  The file
backend/logs/midnightly-log-rotation.sh can be added to a cron job (either via
the system's cron utility or the NodeJS cron module) to keep log files
manageable.  Again, check the paths in this script.

For the frontend scripts, use the browser built-in console.log(),
console.debug(), and console.dir() commands to send debugging information to
the browser's JavaScript console.

Most settings relating to the graphical UI are configured in
frontend/src/ClientConfig.js .  Most settings relating to backend HTTP requests
are configured in backend/Config.js (again, changes to this file require a
NodeJS server restart).

ADAPTERS

As each external database has its own API and quirks, writing a new adapter is
often a process of trial and error.  Use existing adapters as models.

In order for an adapter to show up in the Search Panel, the filename of the
adapter must be included in the array backend/adapters/AdapterList.js and the
NodeJS server must be restarted.  Unwanted adapters can be removed from this list.