-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,37 @@ | ||
# Figgy | ||
|
||
A digital repository application using [Valkyrie](https://github.com/samvera-labs/valkyrie) for persistence. | ||
Figgy is a proof-of-concept port of [Plum](https://github.com/pulibrary/plum) to Valkyrie to explore | ||
functionality, performance, and scalability. | ||
|
||
|
||
## Initial Setup | ||
|
||
```sh | ||
git clone https://github.com/pulibrary/figgy.git | ||
cd figgy | ||
bundle install | ||
``` | ||
|
||
## Setup server | ||
|
||
1. For test: | ||
- `RAILS_ENV=test rake db:setup` | ||
- `rake server:test` | ||
- In a separate terminal: `rspec` | ||
2. For development: | ||
- ``export SECRET_KEY_BASE=`rake secret` `` | ||
- `rake db:setup` | ||
- `rake server:development` | ||
- In a separate terminal: `rails s` | ||
- Access Figgy at http://localhost:3000/ | ||
|
||
|
||
## Background workers | ||
|
||
Some tasks are performed by background workers. To run a Sidekiq background worker process to execute | ||
background jobs that are queued: | ||
|
||
``` | ||
bundle exec sidekiq | ||
``` |