{"id":15152550,"url":"https://github.com/archivesunleashed/auk","last_synced_at":"2025-09-29T23:32:00.274Z","repository":{"id":49041412,"uuid":"108185569","full_name":"archivesunleashed/auk","owner":"archivesunleashed","description":"Rails application for the Archives Unleashed Cloud.","archived":true,"fork":false,"pushed_at":"2021-06-30T12:52:17.000Z","size":52164,"stargazers_count":11,"open_issues_count":13,"forks_count":4,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-12-28T18:11:41.804Z","etag":null,"topics":["apache-spark","archives-unleashed","archives-unleashed-toolkit","rails","rails-application","webarchives"],"latest_commit_sha":null,"homepage":"https://cloud.archivesunleashed.org/","language":"HTML","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/archivesunleashed.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-24T21:27:15.000Z","updated_at":"2023-01-28T08:01:42.000Z","dependencies_parsed_at":"2022-09-08T23:41:36.763Z","dependency_job_id":null,"html_url":"https://github.com/archivesunleashed/auk","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/archivesunleashed%2Fauk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/archivesunleashed%2Fauk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/archivesunleashed%2Fauk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/archivesunleashed%2Fauk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/archivesunleashed","download_url":"https://codeload.github.com/archivesunleashed/auk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234673564,"owners_count":18869689,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["apache-spark","archives-unleashed","archives-unleashed-toolkit","rails","rails-application","webarchives"],"created_at":"2024-09-26T16:03:40.129Z","updated_at":"2025-09-29T23:31:50.968Z","avatar_url":"https://github.com/archivesunleashed.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AUK; Archives Unleashed Cloud\n[![codecov](https://codecov.io/gh/archivesunleashed/auk/branch/main/graph/badge.svg)](https://codecov.io/gh/archivesunleashed/auk)\n[![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md)\n[![LICENSE](https://img.shields.io/badge/license-Apache-blue.svg?style=flat-square)](./LICENSE.txt)\n[![Depfu](https://badges.depfu.com/badges/6e91514923de3f13c37a564add79abf7/overview.svg)](https://depfu.com/github/archivesunleashed/auk?project_id=6474)\n\n![King Auk](https://camo.githubusercontent.com/148a43ac461f352346f8cd894af8bb5845a831fb/68747470733a2f2f7777772e6f6c64626f6f6b696c6c757374726174696f6e732e636f6d2f77702d636f6e74656e742f686967682d7265732f313836372f6772616e6476696c6c652d61756b2d313630302e6a7067)\n\nRails application for the Archives Unleashed Cloud.\n\n## Requirements\n\n* [Ruby](https://www.ruby-lang.org/en/) 2.4.x\n* [Rails](http://rubyonrails.org) 5.1.2 or later\n* [Apache Spark](https://spark.apache.org/) 2.3.2 or later\n* [GraphPass](https://www.github.com/archivesunleashed/graphpass) 0.3.0 or later\n* [NPM](https://www.npmjs.com/) (For testing/ESlint)\n\n## Installation\n\n### Run the test suite\n\nEnsure Rails is _not_ running (ports 3000), then:\n\n```sh\n$ bundle exec rake\n```\n\nIf you would like to make sure JavaScript files are linted:\n\n```sh\n$ npm install\n$ bundle exec rake\n```\n\n### Run a development server\n\n```sh\n$ rails s\n```\n\n### Run the background job\n\nIn another command line tab, run the background job with:\n\n```sh\nbundle exec rake jobs:work\n```\n\nOr to simulate production environment with Delayed::Job:\n\n```\nbin/delayed_job --pool=spark,tasks:1 --pool=graphpass,tasks:1 --pool=seed,tasks:10 --pool=download,tasks:4 --pool=cleanup,tasks:2 --pool=textfilter,tasks:2 start\n```\n\nThen visit http://localhost:3000.\n\n#### Delayed Job Dashboard\n\nTo take advantage of the [Delayed Job Dashboard](https://github.com/tatey/delayed-web), set the `DJW_USERNAME` and `DJW_PASSWORD` in `config/application.yml`. Then visit http://localhost:3000/jobs.\n\n#### Retry jobs\n\nIf you need to \"retry\" a stuck or failed job, you can use the \"retry\" method with a job id (1234):\n\n```\n$ RAILS_ENV=production rails console\nRunning via Spring preloader in process 19680\nLoading production environment (Rails 5.1.4)\nirb(main):001:0\u003e Delayed::Job.find(1234).retry!\n```\n### Configuration\n\nThis application makes use of [figaro](https://github.com/laserlemon/figaro).\n\nYou will need a [`config/application.yml`](https://github.com/archivesunleashed/auk/blob/main/config/application.yml.example) file in the root of the application.\n\n#### Dashboard\n\nSet the `DASHBOARD_USER` and `DASHBOARD_PASS` in `config/application.yml`. Then visit http://localhost:3000/dashboards.\n\n#### Sitemap\n\nTo generate a sitemap:\n\n```\nbundle exec rake sitemap:refresh:no_ping\n```\n\nTo generate a new sitemap, and submit to Google and Bing, setup a cronjob that runs the following:\n\n```\nbundle exec rake sitemap:refresh\n```\n\n### Run a console\n\nYou can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\n## Contributing\n\nPlease see [contributing guidelines](https://github.com/archivesunleashed/auk/blob/main/CONTRIBUTING.md) for details.\n* [Bug reports](https://github.com/archivesunleashed/auk/issues)\n* [Pull requests](https://github.com/archivesunleashed/auk/pulls) are welcome on AUK\n\n## License\n\nThis application is available as open source under the terms of the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).\n\n## Acknowledgments\n\nThis work is primarily supported by the [Andrew W. Mellon Foundation](https://uwaterloo.ca/arts/news/multidisciplinary-project-will-help-historians-unlock). Any opinions, findings, and conclusions or recommendations expressed are those of the researchers and do not necessarily reflect the views of the sponsors.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farchivesunleashed%2Fauk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farchivesunleashed%2Fauk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farchivesunleashed%2Fauk/lists"}