https://github.com/archivesunleashed/auk
Rails application for the Archives Unleashed Cloud.
https://github.com/archivesunleashed/auk
apache-spark archives-unleashed archives-unleashed-toolkit rails rails-application webarchives
Last synced: 8 months ago
JSON representation
Rails application for the Archives Unleashed Cloud.
- Host: GitHub
- URL: https://github.com/archivesunleashed/auk
- Owner: archivesunleashed
- License: other
- Archived: true
- Created: 2017-10-24T21:27:15.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2021-06-30T12:52:17.000Z (almost 5 years ago)
- Last Synced: 2024-12-28T18:11:41.804Z (over 1 year ago)
- Topics: apache-spark, archives-unleashed, archives-unleashed-toolkit, rails, rails-application, webarchives
- Language: HTML
- Homepage: https://cloud.archivesunleashed.org/
- Size: 49.7 MB
- Stars: 11
- Watchers: 7
- Forks: 4
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# AUK; Archives Unleashed Cloud
[](https://codecov.io/gh/archivesunleashed/auk)
[](./CONTRIBUTING.md)
[](./LICENSE.txt)
[](https://depfu.com/github/archivesunleashed/auk?project_id=6474)
Rails application for the Archives Unleashed Cloud.
## Requirements
* [Ruby](https://www.ruby-lang.org/en/) 2.4.x
* [Rails](http://rubyonrails.org) 5.1.2 or later
* [Apache Spark](https://spark.apache.org/) 2.3.2 or later
* [GraphPass](https://www.github.com/archivesunleashed/graphpass) 0.3.0 or later
* [NPM](https://www.npmjs.com/) (For testing/ESlint)
## Installation
### Run the test suite
Ensure Rails is _not_ running (ports 3000), then:
```sh
$ bundle exec rake
```
If you would like to make sure JavaScript files are linted:
```sh
$ npm install
$ bundle exec rake
```
### Run a development server
```sh
$ rails s
```
### Run the background job
In another command line tab, run the background job with:
```sh
bundle exec rake jobs:work
```
Or to simulate production environment with Delayed::Job:
```
bin/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
```
Then visit http://localhost:3000.
#### Delayed Job Dashboard
To 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.
#### Retry jobs
If you need to "retry" a stuck or failed job, you can use the "retry" method with a job id (1234):
```
$ RAILS_ENV=production rails console
Running via Spring preloader in process 19680
Loading production environment (Rails 5.1.4)
irb(main):001:0> Delayed::Job.find(1234).retry!
```
### Configuration
This application makes use of [figaro](https://github.com/laserlemon/figaro).
You will need a [`config/application.yml`](https://github.com/archivesunleashed/auk/blob/main/config/application.yml.example) file in the root of the application.
#### Dashboard
Set the `DASHBOARD_USER` and `DASHBOARD_PASS` in `config/application.yml`. Then visit http://localhost:3000/dashboards.
#### Sitemap
To generate a sitemap:
```
bundle exec rake sitemap:refresh:no_ping
```
To generate a new sitemap, and submit to Google and Bing, setup a cronjob that runs the following:
```
bundle exec rake sitemap:refresh
```
### Run a console
You can also run `bin/console` for an interactive prompt that will allow you to experiment.
## Contributing
Please see [contributing guidelines](https://github.com/archivesunleashed/auk/blob/main/CONTRIBUTING.md) for details.
* [Bug reports](https://github.com/archivesunleashed/auk/issues)
* [Pull requests](https://github.com/archivesunleashed/auk/pulls) are welcome on AUK
## License
This application is available as open source under the terms of the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
## Acknowledgments
This 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.