README

Model Relationship Diagram

Configuration

• Ruby: 2.5.0
• Rails: 5.0.X
• Postgres: 9.5.X
• Redis: 3.3.X

Deployment

Currently Archivist has only been designed to be deployed to Heroku, but rolling your own deployment should not be too difficult.

Some basic steps

1. git clone -b master --single-branch https://github.com/CLOSER-Cohorts/archivist.git
2. cd archivist
3. gem install bundler
4. bundler install
5. Set the environment variable RAILS_ENV=production (e.g. export RAILS_ENV=production)
6. Copy config/application.yml.dist to config/application.yml
7. Set the mailer and database password in the above file
8. rails db:migrate
9. Start server: foreman start - you may need to instal the Foreman gem: gem install foreman

This could cause the webserver to start...

Testing

To run the test suite just call rails test. Currently 197 tests and 256 assertions.

Stats

Name	Lines	LOC	Classes	Methods	M/C	LOC/M
Controllers	1188	755	34	79	2	7
Jobs	136	117	10	10	1	9
Models	2835	1571	40	154	3	8
Mailers	12	11	2	1	0	9
Javascripts	4137	3550	0	432	0	6
Libraries	3041	2359	33	124	3	17
Tasks	362	297	0	0	0	0
Controller tests	862	713	18	93	5	5
Model tests	663	478	30	97	3	2
Mailer tests	11	5	2	0	0	0
Total	13271	9875	169	992	5	7

• Code LOC: 8679
• Test LOC: 1196
• Code to Test Ratio: 1:0.1

Archivist Realtime

Archivist is both a module within Archivist and an entirely separate webapp. Archivist-realtime is very slim Node.js app that provides a communications channel between the Redis cache and all active users via websockets (Socket.io). The purpose of this is to be able to lock objects while editing them and to update a users screen as changes are made to an instrument.