All Projects → samvera → Hyrax

samvera / Hyrax

Licence: apache-2.0
Hyrax is a Ruby on Rails Engine built by the Samvera community. Hyrax provides a foundation for creating many different digital repository applications.

Programming Languages

ruby
36898 projects - #4 most used programming language

Projects that are alternatives of or similar to Hyrax

Boring generators
Boring generators aims to make your development faster by delegating boring setups to us.
Stars: ✭ 125 (-4.58%)
Mutual labels:  rails
Master rails by actions
Rails实战之B2C商城开发 http://eggman.tv/c/s-master-rails-by-actions
Stars: ✭ 127 (-3.05%)
Mutual labels:  rails
Sabisu Rails
Simple and powerful engine for exploring your Rails api application
Stars: ✭ 129 (-1.53%)
Mutual labels:  rails
Kubeapp
Some commonly used kubernetes app 🎉🎉🎉~~~
Stars: ✭ 125 (-4.58%)
Mutual labels:  repository
Creact
crud in Rails and React | Tutorial
Stars: ✭ 126 (-3.82%)
Mutual labels:  rails
Twemoji
Twitter emoji in Ruby 😊
Stars: ✭ 127 (-3.05%)
Mutual labels:  rails
Mandriller
Mandrill SMTP API integration for ActionMailer
Stars: ✭ 124 (-5.34%)
Mutual labels:  rails
Xmake Repo
📦 An official xmake package repository
Stars: ✭ 130 (-0.76%)
Mutual labels:  repository
Awesome Ruby Blogs
A curated list of Awesome Ruby Blogs and Newsletters for Ruby Developers and Newbies
Stars: ✭ 127 (-3.05%)
Mutual labels:  rails
Thinking Sphinx
Sphinx plugin for ActiveRecord/Rails
Stars: ✭ 1,609 (+1128.24%)
Mutual labels:  rails
Zero Rails openapi
Concise DSL for generating OpenAPI Specification 3 (OAS3) JSON documentation for Ruby application.
Stars: ✭ 125 (-4.58%)
Mutual labels:  rails
Activerecord where assoc
Make ActiveRecord do conditions on your associations
Stars: ✭ 126 (-3.82%)
Mutual labels:  rails
Rails sortable
Easy drag & drop sorting with persisting the arranged order for rails
Stars: ✭ 127 (-3.05%)
Mutual labels:  rails
Mwdb Core
Malware repository component for samples & static configuration with REST API interface.
Stars: ✭ 125 (-4.58%)
Mutual labels:  repository
Rspec Openapi
Generate OpenAPI schema from RSpec request specs
Stars: ✭ 129 (-1.53%)
Mutual labels:  rails
Spree auth devise
Provides authentication (user accounts, login & signup) for @spree by using Devise
Stars: ✭ 124 (-5.34%)
Mutual labels:  rails
Drat
Drat R Archive Template
Stars: ✭ 127 (-3.05%)
Mutual labels:  repository
Torque Postgresql
Add support to complex resources of PostgreSQL, like data types, array associations, and auxiliary statements (CTE)
Stars: ✭ 130 (-0.76%)
Mutual labels:  rails
Trace location
🔍Help you get reading the huge open souce libraries in Ruby and trace its source locations
Stars: ✭ 130 (-0.76%)
Mutual labels:  rails
Rails React Typescript Docker Example
An example app built on Ruby on Rails 6.1 + React.js 17 + TypeScript 4.2 + Docker Compose
Stars: ✭ 129 (-1.53%)
Mutual labels:  rails

Hyrax: A Digital Repository Framework

Samvera's Hyrax Logo

Code: Version CircleCI Code Climate

Docs: Documentation Status API Docs Contribution Guidelines Apache 2.0 License

Jump in: Slack Status

Table of Contents

Table of contents created by gh-md-toc

What is Hyrax?

Hyrax is a Ruby on Rails Engine built by the Samvera community. Hyrax provides a foundation for creating many different digital repository applications.

Note: As a Rails Engine, Hyrax is not a web application. To build your digital repository using Hyrax you must mount the Hyrax engine within a Rails application. We call an application that mounts Hyrax a "Hyrax-based application" (or sometimes a "Hyrax Application").

Hyrax offers the ability to:

  • Create repository object types on demand
  • Deposit content via multiple configurable workflows
  • Describe content with flexible metadata
  • Enable/disable optional features via an administrative dashboard
  • And more (https://hyrax.samvera.org/about/)

Feature Documentation

Support Policies

  • Hyrax 3.x supports the latest browser versions for Chrome, Firefox, Edge, and Safari.

Help

The Samvera community is here to help. Please see our support guide.

Working with Hyrax

There are two primary Hyrax development concerns:

  1. Developing the Hyrax engine
  2. Developing your Hyrax-based Application

Developing the Hyrax Engine

This is where you work on the code-base that will be used by yours and other Hyrax-based applications. We recommend using Docker and Hyrax's engine development containers.

Note: This is not the only path for Hyrax-engine development. In the past, we documented extensive steps to install the various dependencies for Hyrax-engine development. There is also a Quick Start for Hyrax engine development that outlines steps for working on the Hyrax engine.

By moving to Docker, we are encoding the documentation steps for standing up a Hyrax-engine development environment.

Contributing

We'd love to accept your contributions. Please see our guide to contributing to Hyrax.

Here are possible ways to help:

  • The Hyrax user interface is translated into a number of languages, and many of these translations come from Google Translate. If you are a native or fluent speaker of a non-English language, your help improving these translations are most welcome. (Hyrax currently supports English, Spanish, Chinese, Italian, German, French, and Portuguese.)
    • Do you see English in the application where you would expect to see one of the languages above? If so, file an issue and suggest a translation, please.
  • Contribute a user story.
  • Help us improve Hyrax's test coverage or documentation coverage.
  • Refactor away code smells.

Release process

See the release management process.

Developing your Hyrax-based Application

For those familiar with Rails, this is where you create your own application (via rails new) and add Hyrax as a gem to your Gemfile. Your Hyrax-based application is the place for you to create features specific to your Hyrax-based application.

For more information, see our documentation on developing your Hyrax-based application.

Deploying your Hyrax-based Application to production

Steps to deploy a Hyrax-based application to production will vary depending on your particular ecosystem but here are some methods and things to consider:

Acknowledgments

This software has been developed by and is brought to you by the Samvera community. Learn more at the Samvera website.

Samvera Logo

License

Hyrax is available under the Apache 2.0 license.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].