Cornell University implementation of Blacklight

Requirements

• Docker
• CUL VPN

Development Setup

1. Clone the GitHub repo
2. Set up your env file in the rails_env/ directory, e.g. at rails_env/.env.dev
   • Contact the Library Systems team for access to environment values
3. Connect to the library VPN
4. Build the blacklight-cornell container image for development: ./build.sh -dr rails_env/YOUR_DEV_ENV_FILE
   • To rebuild the image without cache: ./build.sh -dnr rails_env/YOUR_DEV_ENV_FILE
5. Run the docker image: ./run.sh -dr rails_env/YOUR_DEV_ENV_FILE

The Blacklight instance should be accessible from:

http://0.0.0.0:9292

Refer to UI Development for additional information.

Testing

1. Set up your env file in the rails_env/ directory, e.g. at rails_env/.env.test
   • Contact the Library Systems team for access to environment values
2. Build the test image: ./build_test.sh
3. Ssh into a running test container: ./run_test.sh -ir rails_env/YOUR_TEST_ENV_FILE
4. Run tests:
   • cucumber: ./jenkins-opts.sh features/assumptions/assume.feature
   • rspec: bundle exec rspec spec/helpers/advanced_helper_spec.rb

For additional options and a more detailed explanation, refer to Running Tests.