Skip to content

Latest commit

 

History

History
75 lines (57 loc) · 3.56 KB

README.md

File metadata and controls

75 lines (57 loc) · 3.56 KB
Raw

Avalon Media System

Avalon Media System is an open source system for managing large collections of digital audio and video. The project is led by the libraries of Indiana University and Northwestern University with funding in part from the Institute of Museum and Library Services and the Andrew W. Mellon Foundation.

CircleCI Maintainability Test Coverage Stories in Ready

For more information and regular project updates visit the Avalon blog.

Quickstart development with Docker

Docker provides an alternative way of setting up an Avalon Media System Development Environment in minutes without installing any dependencies beside Docker itself. It should be noted that the docker-compose.yml provided here is for development only and will be updated continually.

  • Install Docker and docker-compose
  • git clone https://github.com/samvera-labs/avalon-bundle
  • cd avalon-bundle
  • docker-compose pull
  • docker-compose up avalon

Avalon is served by Puma in development mode so any changes will be picked up automatically.

Rails debugging with Pry can be accessed by attaching to the docker container: docker attach avalon_container_name. Now, when you reach a binding.pry breakpoint in rails, you can step through the breakpoint in that newly attached session.

To get live compilation and hot-reload when developing with Javascript, run WEBPACKER_DEV_SERVER_HOST=0.0.0.0 $NODE_PATH/.bin/webpack-dev-server --config /home/app/avalon/config/webpack/development.js inside the avalon container.

To run tests, first bring up the test stack then run Rspec as usual:

  • docker-compose up test.
  • docker-compose exec test bash -c "bundle exec rspec".

Getting Started (without Docker)

bundle install
yarn install
rails db:migrate
rails hydra:server

(Alternative instructions) Getting Started Without Docker for Mac OSX

bundle install
yarn install
bundle exec rails db:migrate

If you don't have Redis server running automatically on your machine at start up, start it manually:

redis-server`

Start Solr and Fedora manually:

solr_wrapper
fcrepo_wrapper

Configure an admin set, so that you can do things like add a new Work:

rails hyrax:default_admin_set:create

Configure fits; see instructions here, specifically list item #4: https://github.com/samvera/hyrax/wiki/Configuring-an-OS-X-Samvera-Dev-Environment#configuring-hyrax

Start the application:

bundle exec rails s

By default it will run on port :3000. If you have a port conflict in your local dev / bash environment, you can specify a port directly, ie: bundle exec rails s -p 3333

Visit http://localhost:3000/ and make sure the application loads.

Sign up a new user:

username: [email protected]
password: archivist1