Skip to content
This repository has been archived by the owner on Jul 28, 2021. It is now read-only.

Latest commit

 

History

History
48 lines (32 loc) · 1.56 KB

quickstart_demo.md

File metadata and controls

48 lines (32 loc) · 1.56 KB

Circa Demo & Development with Vagrant

Prerequisites

  1. Vagrant

  2. VirtualBox

  3. Circa requires an ArchivesSpace installation with the following additional requirements:

    a. Version 2.5.2 or higher or, for earlier versions, the archivesspace-component-uri-display-plugin](https://github.com/NCSU-Libraries/archivesspace-component-uri-display-plugin) installed and enabled on your ArchivesSpace installation.

    b. ArchivesSpace username and password. The Circa demo will retrieve resource URIs from ArchiveSpace which requires a username and password. This should be a new account that is just used for Circa. It requires read access to all ArchivesSpace resources.

Quick Start

Installation

Verify the prerequisites listed above.

Check out the code and change directories:

git clone git@github.com:NCSU-Libraries/circa.git
cd circa

Copy config/application_example.yml to config/application.yml:

cp config/application_example.yml config/application.yml

Update config/application.yml with the appropriate ArchiveSpace connection parameters.

Start Vagrant:

vagrant up

SSH to Vagrant machine and start Rails:

vagrant ssh
cd /vagrant
bundle exec rails s -b 0.0.0.0

View Circa in your browser on the host machine at localhost:3000.

Log in using the username admin@circa and the password circa_admin.