Skip to content

Commit

Permalink
Updated import methods on README
Browse files Browse the repository at this point in the history
  • Loading branch information
leefaisonr committed Aug 25, 2023
1 parent cc99849 commit d03a0e2
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Records are arranged alphabetically with authors, titles, and subjects interfile

This project uses [asdf](https://asdf-vm.com/) (see .tool-versions for the current ruby version)

`bundle install` will install the dependencies for this project.
`bundle install` will install the dependencies for this project. Use `bundle install` also when updating ruby gems for this project.

## Database Setup

Expand All @@ -27,23 +27,34 @@ Startup: `rake servers:start`

## How to start application locally

Run the `bin/rails server` command, then in a browser connect to [localhost:3000](http://localhost:3000/)
Run the `bin/rails server` or `rails s` command, then in a browser connect to [localhost:3000](http://localhost:3000/)

## How to run the test suite

`bundle exec rspec spec`
`bundle exec rspec <spec/**/*>`

## Deploying

Currently, this application can not be deployed with pulbot. You must use Capistrano on the command line.
You may use Capistrano on the command line.

`BRANCH=branch_name bundle exec cap staging deploy`

`BRANCH=branch_name bundle exec cap production deploy`

Alternatively, you may deploy from [ansible-tower](https://ansible-tower.princeton.edu/).

## How to load data

We want to load in CSV files that contain GuideCards and SubGuides data, which was exported from the legacy version of this application. The data lives in the `data` folder of this project.
We want to load in CSV files that contain GuideCard and SubGuideCard data, which was exported from the legacy version of this application. The data lives in the `data` folder of this project.

To list all import services for the application: `rake -T | grep import`

To import the GuideCard records: `rake import:import_guide_cards`
To import the SubGuideCard records: `rake import:import_sub_guide_cards`

The CardImage records are the images that are included in the GuideCard and SubGuideCard records. These will take the longest to import (totaling ~1.5 million images).

To import the GuideCards records: `rake import:import_guide_cards`
To import the CardImage records: `rake import:import_card_images`

## Install lux

Expand Down

0 comments on commit d03a0e2

Please sign in to comment.