Skip to content

Commit

Permalink
Merge pull request #903 from pulibrary/fix_readme
Browse files Browse the repository at this point in the history
Update and format startup instructions
  • Loading branch information
hackartisan committed May 11, 2021
2 parents 2329c44 + 0789913 commit e75c6e5
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 10 deletions.
1 change: 0 additions & 1 deletion Procfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Procfile
backend: bin/rails s -p 3000
frontend: bin/webpack-dev-server
solr: bundle exec rake dpul:development
sidekiq: bundle exec sidekiq
28 changes: 19 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,35 @@ formerly known as Pomegranate, but renamed to the offical brand: Digital PUL.
* Redis (install via homebrew and run via `homebrew services`)


## Setup
## Initial Setup

```sh
git clone git@github.com:pulibrary/dpul.git
cd dpul
bundle install
yarn install
bundle exec rake db:create
bundle exec rake db:migrate
```

After setup, start solr, postgresql and redis with:
Remember you'll need to run `bundle install` and `yarn install` on an ongoing basis as dependencies are updated.

`bundle exec rake servers:start`
## Setup server

Then, start webpack-dev-server, sidekiq and rails, each in their own terminal window:
`bin/webpack-dev-server`
`bundle exec sidekiq`
`bin/rails s -p 3000`
### Lando

Lando will automatically set up docker images for Solr and Postgres which match
the versions we use in Production. The ports will not collide with any other
projects you're using Solr/Postgres for, and you can easily clean up with `lando
destroy` or turn off all services with `lando poweroff`.

1. Install Lando DMG from <https://github.com/lando/lando/releases>
1. `rake servers:start`

1. For test:
- In a separate terminal: `bundle exec rspec`
1. For development:
- In a separate terminal: `foreman start`
- Or run services separately as shown in <https://github.com/pulibrary/dpul/blob/main/Procfile>
- Access DPUL at <http://localhost:3000/>

### Importing Data:

Expand Down

0 comments on commit e75c6e5

Please sign in to comment.