Giter Club home page Giter Club logo

linkomatic's Introduction

Link-o-matic

Description

This is a project to help automate the insertion of links to digitized records into EAD finding aids.

Code Repository

The code lives in the Berkman Center's GitHub repo.

User Documentation

User documentation exists in the doc folder.

Requirements

  • Git
  • Ruby >= 2
  • Bundler
  • PostgreSQL (including -dev packages)
  • Redis server

Bundler should take care of the rest.

Setup

  • Install requirements (see above)
  • Checkout the code
    • git clone https://github.com/berkmancenter/linkomatic
    • cd linkomatic
  • Install libraries
    • bundle install
  • Configure the database
    • cp config/database.yml.example config/database.yml
    • Setup a postgres user and update config/database.yml accordingly
    • rake db:create
    • rake db:setup
  • Configure the websockets server
    • If you're using Apache, you'll need to setup config/initializers/websocket_rails.rb according to this
    • Configure config.websocket_url somewhere in your app config, probably in the various config/environments/
    • Again, if you're using Apache, you'll need to run rake websocket_rails:start_server
  • Start sidekiq workers
    • sidekiq --daemon --concurrency 10 --logfile tmp/sidekiq.log
  • Update the devise configs
    • Use rake secret to generate a new secret key and add it to config/initializers/devise.rb
    • Update the config.mailer_sender in config/initializers/devise.rb
  • Create an admin user
    • Sign up for an account
    • Use the console (rails c) to set the admin attribute on that user, e.g. User.find(3).update_attribute('admin', true)

Tested Configurations

  • Phusion Passenger, Ruby 2.1.2, Apache 2.2, Ubuntu 12.04 LTS
  • Phusion Passenger, Ruby 2.1.4, Apache 2.4, Ubuntu 14.04 LTS

Issue Tracker

We maintain a closed-to-the-public issue tracker. Any additional issues can be added to the GitHub issue tracker.

Built With

The generous support of the Harvard Library Lab, the Harvard Library Office for Scholarly Communication, the Berkman Center for Internet & Society and the Arcadia Fund

Technologies

Contributors

Justin Clark

License

Apache 2.0 - See the LICENSE file for details.

Copyright

Copyright © 2014 President and Fellows of Harvard College

linkomatic's People

Stargazers

Michael Corrado avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.