Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A web service that exposes all of the documents stored in the solr index.
Ruby HTML Cucumber JavaScript Other
Tree: e26178b250

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
app
config
db
doc
features
lib/tasks
public
script
spec
test
vendor/plugins
.gitignore
Gemfile
README
Rakefile
config.ru

README

##########################################################################
# Copyright 2011 Applied Research in Patacriticism and the University of Virginia
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
##########################################################################

Collex Catalog
--------------------------------------

This provides the backend that provides a public interface to the documents stored in solr.
You only need to set this up if you are not adding your Federation to the ones in ARC, but
you are setting up a completely independent copy of the whole collex tool chain.

--------------------------------------
Collex architecture

Collex is a complex project made up of a number of subprojects that all have to be in place
for it to work. Most users will probably just need to set up the main Collex piece and point it at
the existing Catalog. If that is all you want to do, then you don't need to understand the following
architecture and you don't need to download the "solr" or "catalog" projects.

When Collex is deployed, it is branded with the name of a particular "Federation", like NINES or 18thConnect.
The website that the end user goes to will look like that federation, but the code behind it is the "collex"
project here.

When a search is done from "collex", the request is made to the "catalog" project, which is a web service
that exposes all the documents that have been stored.

The "catalog" webservice processes the request and forms the correct call to the "solr" webservice.

The documents are added to the solr index by converting RDF documents using the project "rdf-indexer".

The About section of "collex" and the News section of "collex" are two separate WordPress installations. The
recommended theme to use is in the "collex_wordpress_theme" project.

The "typewright" project can be attached to a "collex" instance if you wish by setting it up in the site.yml file
of "collex". The "typewright" project is a webservice that keeps the information about all the typewright-enabled
documents. The actual web presence of typewright is in the "collex" project under subfolders named typewright.

--------------------------------------
Deployment

1) Download this project.
2) Copy config/database.example.yml to config/database.yml.
3) Copy config/site.example.yml to config/site.yml.
4) Modify those two files to suit your server and your needs. There are comments in them. DO NOT CHECK THEM IN!
5) The first time you run, you will have to run "bundle install".
6) Any time you make a change that you want to deploy, check your change in, then run "rake deploy".

Something went wrong with that request. Please try again.