{"id":35747601,"url":"https://github.com/sul-dlss/searchworks","last_synced_at":"2026-01-26T20:29:41.684Z","repository":{"id":16625490,"uuid":"19380542","full_name":"sul-dlss/SearchWorks","owner":"sul-dlss","description":"SearchWorks (Stanford University Libraries)","archived":false,"fork":false,"pushed_at":"2026-01-20T16:58:21.000Z","size":20359,"stargazers_count":52,"open_issues_count":112,"forks_count":10,"subscribers_count":20,"default_branch":"main","last_synced_at":"2026-01-21T01:20:26.908Z","etag":null,"topics":["access","application","blacklight-application","rails","ruby"],"latest_commit_sha":null,"homepage":"http://searchworks.stanford.edu","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sul-dlss.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2014-05-02T16:08:20.000Z","updated_at":"2026-01-20T16:55:10.000Z","dependencies_parsed_at":"2023-12-23T18:32:18.559Z","dependency_job_id":"29eb7ecc-58a7-440a-96c3-b5159d19379b","html_url":"https://github.com/sul-dlss/SearchWorks","commit_stats":null,"previous_names":[],"tags_count":352,"template":false,"template_full_name":null,"purl":"pkg:github/sul-dlss/SearchWorks","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sul-dlss%2FSearchWorks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sul-dlss%2FSearchWorks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sul-dlss%2FSearchWorks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sul-dlss%2FSearchWorks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sul-dlss","download_url":"https://codeload.github.com/sul-dlss/SearchWorks/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sul-dlss%2FSearchWorks/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28787221,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T13:55:28.044Z","status":"ssl_error","status_checked_at":"2026-01-26T13:55:26.068Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["access","application","blacklight-application","rails","ruby"],"created_at":"2026-01-06T18:17:28.466Z","updated_at":"2026-01-26T20:29:41.678Z","avatar_url":"https://github.com/sul-dlss.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Build Status](https://github.com/sul-dlss/SearchWorks/workflows/CI/badge.svg) | \n[![Code Climate](https://codeclimate.com/github/sul-dlss/SearchWorks/badges/gpa.svg)](https://codeclimate.com/github/sul-dlss/SearchWorks) | \n[![Code Climate Test Coverage](https://codeclimate.com/github/sul-dlss/SearchWorks/badges/coverage.svg)](https://codeclimate.com/github/sul-dlss/SearchWorks/coverage)\n\n# SearchWorks\n\nThe Stanford library searchable catalog.\n\n## Local Installation\n\nYou'll need common dependencies for building rails applications such as a javascript runtime (e.g. v8).  If you don't want to have the mysql gem installed for local development you can run the bundle install command below with the `--without production deployment` flag\n\nAfter cloning the repository\n\n    $ bundle install\n    $ yarn install\n    $ rake searchworks:install\n\nThe installation script will\n\n1. Migrate the database\n\nYou will need to update the configuration in `config/settings.yml` for various parts of the app to work.  Please check that file for more information.\n\n### Start Solr\n\nThere are at least two options for starting Solr.\n\n#### Docker compose\n\n```shell\ndocker compose up\n```\n\n#### solr_wrapper \nTo start Solr, you can use the `solr_wrapper` command. However, if starting from a fresh instance, you may first need to run `rake searchworks:install` or `rake ci` so that the CJK tokenizer gets copied into the appropriate directory.  There is also a separate task (`rake searchworks:copy_solr_dependencies`) available if you find that you need to clean solr and the CJK tokenizer is getting removed.\n\n    $ solr_wrapper\n\n### Start the rails app\nStart the rails app\n\n    $ bin/dev\n\n## Getting data in development\n\nOnce you have Solr running you can load fixture data using `bin/rails searchworks:fixtures`\nWe have included fixture files in the `spec/fixtures/solr_documents` directory.\n\nIf you want to add other documents you can add the identifiers into `FixtureHarvester`. This will download more yml files to the fixture folder. Run `bin/rails searchworks:fixtures` again to reindex.  Please submit your changes and the new yaml files via a pull request. Please use this judiciously as adding many fixtures may add unnecessary complexity and size to the codebase.\n\n## \"Logging in\" as a User in development\n\nGiven that this app is using shibboleth + devise for login, it can be tricky to get a user context set.  The user itself can be set by starting rails with a `REMOTE_USER` env var set (e.g. `REMOTE_USER=jstanford bin/dev`).\n\nIf you need to set your affiliation attribute (e.g. `stanford:staff`) for things like testing article search, you can start rails with a `suAffiliation` env var set (e.g. `REMOTE_USER=jstanford suAffiliation=stanford:staff bin/dev`).\n\nOne caveat to this is that you may still need to go through the login path `/sso/login` in order to ensure proper session setup (e.g. eds guest flag set).\n\n## Testing\n\nThere is one testing task: `rake ci`\n\n#### ci\n\nThis is intended for running tests against the fixtures in the local index.\n\n    $ rake ci\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsul-dlss%2Fsearchworks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsul-dlss%2Fsearchworks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsul-dlss%2Fsearchworks/lists"}