Skip to content

Commit

Permalink
Improving setup instructions (#32)
Browse files Browse the repository at this point in the history
  • Loading branch information
escowles authored and Trey Pendragon committed Jul 31, 2017
1 parent 9628d06 commit 5a0400b
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
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
```

0 comments on commit 5a0400b

Please sign in to comment.