Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improving setup instructions #32

Merged
merged 1 commit into from
Jul 31, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
```