Skip to content
Merged
Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions .solr_wrapper
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ignore_checksum: true
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ GEM
multipart-post (>= 1.2, < 3)
faraday_middleware (0.14.0)
faraday (>= 0.7.4, < 1.0)
ffi (1.13.1)
ffi (1.15.5)
figs (3.0.0)
git (~> 1.2)
rake (>= 10.1)
Expand Down
55 changes: 39 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# NYU Spatial Data Repository

[![Build Status](https://travis-ci.com/NYULibraries/spatial_data_repository.svg?branch=main)](https://travis-ci.com/NYULibraries/spatial_data_repository) ![Supported Ruby Version](https://img.shields.io/badge/ruby%20version-2.5.7-green?style=flat-square) [![Maintainability](https://api.codeclimate.com/v1/badges/080a26a69fcbdb0e6286/maintainability?style=flat-square)](https://codeclimate.com/github/NYULibraries/spatial_data_repository/maintainability) [![Depfu](https://badges.depfu.com/badges/87261b603e6941c0578dd5de1225650f/overview.svg)](https://depfu.com/github/NYULibraries/spatial_data_repository?project_id=10547)
[![CI](https://github.com/NYULibraries/spatial_data_repository/actions/workflows/ci.yml/badge.svg)](https://github.com/NYULibraries/spatial_data_repository/actions/workflows/ci.yml)

This repository tracks the implementation of GeoBlacklight used to power the front-end of NYU Libraries [Spatial Data Repository](https://geo.nyu.edu)

Expand All @@ -12,21 +12,44 @@ This repository tracks the implementation of GeoBlacklight used to power the fro
- [Contributing Guide](docs/CONTRIBUTING.md)


## Development Quickstart
## Local Development Quickstart

Below are barebones steps for getting started in development for the SDR. For more in depth instructions, see [CONTRIBUTING](docs/CONTRIBUTING.md#development-guide).

- Make sure you have Git, Vagrant, and VirtualBox installed.
- Run the commands below in order specified:
```sh
$ git clone https://github.com/NYULibraries/spatial_data_repository.git && cd spatial_data_repository
$ vagrant up
$ vagrant ssh
$ cd /vagrant/sdr
$ cp config/vars.yml.example config/vars.yml
$ bundle exec rake db:schema:load
$ bundle exec rake sdr:server
```

- View to test environment Solr admin panel: http://localhost:8983/
- View the operating GeoBlacklight Rails app: http://localhost:3000
### Using Vagrant

#### Prerequisites
- Git
- Vagrant
- VirtualBox

#### Steps

1. Run the commands below in order specified:
- `git clone https://github.com/NYULibraries/spatial_data_repository.git && cd spatial_data_repository`
- `vagrant up`
- `vagrant ssh`
- `cd /vagrant/sdr`
- `cp config/vars.yml.example config/vars.yml`
- `bundle exec rake db:schema:load`
- `bundle exec rake sdr:server`
2. View to test environment Solr admin panel: http://localhost:8983/
3. View the operating GeoBlacklight Rails app: http://localhost:3000

### On Mac (no virtualization)

#### Prerequisites
- Git (`brew install git`)
- Ruby (via RVM or Rbenv)
- Mysql (`brew install mysql`)
- Java (`brew install openjdk@11` or [Oracle Downloads](https://www.oracle.com/java/technologies/javase/jdk11-archive-downloads.html))

#### Steps

1. Run the commands below in order specified:
- `git clone https://github.com/NYULibraries- spatial_data_repository.git && cd- spatial_data_repository`
- `cp config/vars.yml.example config/vars.yml`
- `bundle exec rake db:schema:load`
- `bundle exec rake sdr:server`
2. View to test environment Solr admin panel: http://localhost:8983/
3. View the operating GeoBlacklight Rails app: http://localhost:3000