aviary

Description

A cloud-based platform for publishing searchable audio and video content that pinpoints search results to the exact place where a search term is found.

Collaboration between AVP and the Fortunoff Video Archive for Holocaust Testimonies.

Setup and Configuration

• Copy .env.example to .env

    cp .env.example .env
  

  put correct configuration variables in the .env

• Run Solr instance or use sunspot solr

    bundle exec rake sunspot:solr:start
  

  Sunspot Solr for more detail.

  if you are running a separate Solr instance then use the conf folder that is available in solr/configsets/sunspot/conf

• Solr Index

    rake aviary:solr_index:default
  

  Run this task to re-index critical/fundamental project models to be indexed by solr. Other available tasks are:

    rake aviary:solr_index:organizations
    rake aviary:solr_index:collections
    rake aviary:solr_index:collection_resources
    rake aviary:solr_index:collection_resource_files
    rake aviary:solr_index:given_class[ClassName] e.g. CollectionResource
    rake aviary:solr_index:thesaurus_terms
  

• Create Database

    bundle exec rake db:create 
  

• Run DB Migrations

    bundle exec rake db:migrate
  

• Run DB Seed

    bundle exec rake db:seed
  

• Run rails server

    rails s
  

Sample Login

• Admin

  • email: admin@demo.com
  • password: demoadmin

• User

  • email: user@demo.com
  • password: demouser

Requirements

• OS: >= Ubuntu 20.04
• Ruby: 3.1.0
• Rails: 6.1.7.6
• Nginx
• Puma
• MySQL: >=5.7.x
• imagick: >=6.7.2
• ffmpeg: >=2.6.8
• git: >=1.7.1
• 7z
• Apache Solr >= 7.6.x
• Redis
• Youtube-dl
• exiftool

Third Party Services

• AWS S3,
• AWS Cloudfront
• AWS SES
• Wasabi Storage

Helpful Links

• Setup Rails app using Passenger
• Install MySQL
• Install ffmpeg

Contributing

Check out the Contributing guide.

Code of Conduct

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Code of Conduct.

License

See the LICENSE and THIRD-PARTY-LICENSE files for information on the project licenses and the licenses of incorporated third-party software.

Contributors

• Nouman Tayyab nouman@weareavp.com
• Furqan Wasi furqan@weareavp.com
• Rimsha Khalid rimsha@weareavp.com
• Zaheer Abdul Wajid zaheer@weareavp.com
• Raza Saleem raza@weareavp.com
• Usman Javaid usman@weareavp.com